Corrigo: Contact schemas
1 Corrigo schema with complete fields and constraints.
← Contact operations · All schemas
Create contact — request body — body entity
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | integer | Optional | Format: int32 |
isNew | boolean | Optional | Read only: true |
limitMultipleEntitiesNumberBehaviour | boolean | Optional | |
performDeletion | boolean | Optional | |
properties | JSON | Optional | |
properties (anyOf 1) | array | Alternative | |
properties (anyOf 1)[] | JSON | Each item | |
properties (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo PropertyTreeNode. |
properties (anyOf 1)[] (anyOf 2) | null | Alternative | |
properties (anyOf 2) | null | Alternative | |
concurrencyId | integer | Optional | Format: int32 |
isRemoved | boolean | Optional | |
canCreateRequest | boolean | Optional | |
canViewAnyRequest | boolean | Optional | |
comment | JSON | Optional | |
comment (anyOf 1) | string | Alternative | |
comment (anyOf 2) | null | Alternative | |
contactAddresses | JSON | Optional | |
contactAddresses (anyOf 1) | array | Alternative | |
contactAddresses (anyOf 1)[] | JSON | Each item | |
contactAddresses (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo ContactInfo. |
contactAddresses (anyOf 1)[] (anyOf 2) | null | Alternative | |
contactAddresses (anyOf 2) | null | Alternative | |
countryId | JSON | Optional | |
countryId (anyOf 1) | string | Alternative | |
countryId (anyOf 2) | null | Alternative | |
currencies | JSON | Optional | |
currencies (anyOf 1) | array | Alternative | |
currencies (anyOf 1)[] | JSON | Each item | |
currencies (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo ContactMoneyValues. |
currencies (anyOf 1)[] (anyOf 2) | null | Alternative | |
currencies (anyOf 2) | null | Alternative | |
customFields | JSON | Optional | |
customFields (anyOf 1) | array | Alternative | |
customFields (anyOf 1)[] | JSON | Each item | |
customFields (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo CustomField2. |
customFields (anyOf 1)[] (anyOf 2) | null | Alternative | |
customFields (anyOf 2) | null | Alternative | |
customerId | integer | Optional | Format: int32 |
customerNoteAccessId | string | Optional | One of: Unknown, None, View, AddEdit Format: int32 |
displayAs | JSON | Optional | |
displayAs (anyOf 1) | string | Alternative | |
displayAs (anyOf 2) | null | Alternative | |
firstName | JSON | Optional | |
firstName (anyOf 1) | string | Alternative | |
firstName (anyOf 2) | null | Alternative | |
groupsBridge | JSON | Optional | |
groupsBridge (anyOf 1) | array | Alternative | |
groupsBridge (anyOf 1)[] | JSON | Each item | |
groupsBridge (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo LinkContactAndGroup. |
groupsBridge (anyOf 1)[] (anyOf 2) | null | Alternative | |
groupsBridge (anyOf 2) | null | Alternative | |
languageId | integer | Optional | Format: int32 |
lastName | JSON | Optional | |
lastName (anyOf 1) | string | Alternative | |
lastName (anyOf 2) | null | Alternative | |
mustResetPassword | boolean | Optional | |
noAlertEmails | boolean | Optional | |
noPwdExpirationAlert | boolean | Optional | |
number | JSON | Optional | |
number (anyOf 1) | string | Alternative | |
number (anyOf 2) | null | Alternative | |
priorityThreshold | integer | Optional | Format: int32 |
supervisorId | integer | Optional | Format: int32 |
typeId | string | Optional | One of: Unknown, Alternate, Emergency, Primary Format: int32 |
unlimitedAuthorization | boolean | Optional | |
unlimitedRequest | boolean | Optional | |
username | JSON | Optional | |
username (anyOf 1) | string | Alternative | |
username (anyOf 2) | null | Alternative |