...
| Info |
|---|
| The information in this document is currently in BETA and subject to change. |
The Partcipant Types resource represents the types of participants for actions.
Resource Properties
| Scope Parameter | participanttypes |
|---|
| Location | /participanttypes |
|---|
| Methods | GET |
|---|
| Default Page Size | 50 |
|---|
| Max Page Size | 200 |
|---|
| Default Includes | None |
|---|
Resource Attributes
| Field | Description | Format | Required | Field Type | Restrictions | Notes |
|---|
| name | The name of the participant type. | string (50) | true | default |
| |
|
|
| displayName |
| string | false | default | Read-only |
|
| description | The description of the participant type. | string (255) | false | default |
| |
|
|
| isBaseParticipantType | Indicates if this is the default participant type for a contact. | boolean | true | default |
| |
|
|
| companyFlag | Indicates whether the base participant type flag applies to individals or companies. | boolean | false | default |
| |
|
|
| taxNumberAlias | The alias for the tax number for this participant type. | string | false | default |
|