The Participants resource is one the central resources in the Actionstep system. Many other resources reference it and there are a large number of resources that extend this base resource.
Resource Properties
| Location |
|---|
...
| /participants |
...
| Methods |
|---|
...
| GET POST PUT DELETE OPTIONS | |
| Default Page Size |
...
| 50 | |
| Max Page Size |
...
| 100 | |
| Default Includes |
...
| None |
Resource Atributes
| Field | Description | Format | Required | Field Type | Notes |
|---|---|---|---|---|---|
| displayName | The participants name formatted as defined by the Display Name Format global preference. | string | true | default | |
| isCompany | Defines the participant as either a Company or Individual. | boolean | true | default | |
| companyName | The name of the company if the participant is a Company, or the name of the employer if the participant is an Individual. | string | false | default | |
| salutation | The Individual's prefix. | string | false | default | |
| firstName | The Individual's first name. | string | false | default | |
| middleName | The Individual's middle name. | string | false | default | |
| lastName | The Individual's last name. | string | false | default | |
| suffix | The Individual's suffix. | string | false | default | |
| preferredName | The Individual's preferred name. | string | false | additional | |
| physicalAddressLine1 | The primary field for the physical address of the participant. | string | false | default | |
| physicalAddressLine2 | An optional secondary address field for the physical address. | string | false | default | |
| physicalCity | The city portion of the physical address. | string | false | default | |
| physicalStateProvince | The state or province portion of the physical address. | string | false | default | |
| physicalPostCode | The postcode or zip code portion of the physical address. | string | false | default | |
| physicalCountry | The associated countries resource for the country portion of the physical address. | string | false | link | |
| mailingAddressLine1 | The primary field for the mailing address of the participant. | string | false | additional | |
| mailingAddressLine2 | An optional secondary address field for the mailing address. | string | false | additional | |
| mailingCity | The city portion of the mailing address. | string | false | additional | |
| mailingStateProvince | The state or province portion of the mailing address. | string | false | additional | |
| mailingPostCode | The postcode or zip code portion of the mailing address. | string | false | additional | |
| mailingCountry | The associated countries resource for the country portion of the mailing address. | string | false | link | |
| phone1Label | A description of the primary phone number. | string | false | default | |
| phone1Country | The country portion of the primary phone number. | string | false | default | |
| phone1Area | The area code portion of the primary phone number. | string | false | default | |
| phone1Number | The number portion of the primary phone number. | string | false | default | |
| phone1Notes | A notes field for the primary phone number. | string | false | default | |
| phone2Label | A description of the secondary phone number. | string | false | additional | |
| phone2Country | The country portion of the secondary phone number. | string | false | additional | |
| phone2Area | The area code portion of the secondary phone number. | string | false | additional | |
| phone2Number | The number portion of the secondary phone number. | string | false | additional | |
| phone2Notes | A notes field for the secondary phone number. | string | false | additional | |
| phone3Label | A description of the tertiary phone number. | string | false | additional | |
| phone3Country | The country portion of the tertiary phone number. | string | false | additional | |
| phone3Area | The area code portion of the tertiary phone number. | string | false | additional | |
| phone3Number | The number portion of the tertiary phone number. | string | false | additional | |
| phone3Notes | A notes field for the tertiary phone number. | string | false | additional | |
| phone4Label | A description of the quaternary phone number. | string | false | additional | |
| phone4Country | The country portion of the quaternary phone number. | string | false | additional | |
| phone4Area | The area code portion of the quaternary phone number. | string | false | additional | |
| phone4Number | The number portion of the quaternary phone number. | string | false | additional | |
| phone4Notes | A notes field for the quaternary phone number. | string | false | additional | |
| fax | The participant's fax number. | string | false | additional | |
| sms | The number to use for SMS. | string | false | additional | |
| The participant's email address. | string | false | default | ||
| website | The participant's web address. | string | false | additional | |
| occupation | The participant's occupation. | string | false | additional | |
| taxNumber | The tax number. | string | false | additional | Uses the Tax Number Alias on the Base Participant Type. |
| birthTimestamp | The participant's Date of Birth. | timestamp | false | default | |
| deathTimestamp | The participant's Date of Death. | timestamp | false | additional | |
| maritalStatus | Marital status. | string | false | default | |
| gender | Gender. | string | true | default | |
| emailFormat | The preferred email format for the participant. | string | false | additional | Text / HTML |
| notificationMethod | The preferred notification method for the participant. | string | false | additional | |
| isNewsletterSubscriber | If the participant is a Newsletter subscriber. | boolean | false | additional | Deprecated? |
| modifiedTimestamp | Timestamp when the record was last modified. | timestamp | false | additional | |
| createdTimestamp | Timestamp when the record was created. | timestamp | false | additional | |
| division | The associated divisions resource for the participant. | string | true | link | |
| billingPreference | The associated billingpreference resource of the participant. | string | false | link |
...