Contacts API
| Action | Endpoint |
|---|---|
| Create contact | POST/contact/{tenantLocator}/contacts |
| Fetch contact | GET/contact/{tenantLocator}/contacts/{locator} |
| Lookup contact | GET/contact/{tenantLocator}/contacts/lookup/{locator} |
| List contacts | GET/contact/{tenantLocator}/contacts/{staticLocator}/list |
| Update contact | PATCH/contact/{tenantLocator}/contacts/{locator} |
| Validate contact | PATCH/contact/{tenantLocator}/contacts/{locator}/validate |
| Merge contacts | PATCH/contact/{tenantLocator}/contacts/merge |
Create contact
Create contact
addContactPOST
/contact/{tenantLocator}/contactsParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes |
ContactCreateRequest
Required properties
| Property | Type | Description |
|---|---|---|
autoValidate | boolean | |
type | string | |
data | map<string, object> |
Optional properties
| Property | Type | Description |
|---|---|---|
region | string? |
Contact
Required properties
| Property | Type | Description |
|---|---|---|
locator | ulid | |
staticLocator | ulid | |
contactState | Enum draft | validated | discarded | |
type | string | |
data | map<string, object> | |
createdAt | datetime | |
createdBy | uuid |
Optional properties
| Property | Type | Description |
|---|---|---|
region | string? | |
anonymizedAt | datetime? | |
updatedAt | datetime? | |
updatedBy | uuid? | |
validationResult | ValidationResult? |
Fetch contact
Fetch contact
getContactGET
/contact/{tenantLocator}/contacts/{locator}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
locator | path | ulid | Yes |
Response:
ContactSecurity Group:
contactsPermission:
readLookup contact
Lookup contact
lookupContactGET
/contact/{tenantLocator}/contacts/lookup/{locator}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
locator | path | ulid | Yes |
Response:
ContactSecurity Group:
contactsPermission:
readList contacts
List contacts
listContactsGET
/contact/{tenantLocator}/contacts/{staticLocator}/listParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
staticLocator | path | ulid | Yes | |
offset | query | integer? | No | |
count | query | integer? | No |
Response:
ListPageResponseContactSecurity Group:
contactsPermission:
readListPageResponseContact
Required properties
| Property | Type | Description |
|---|---|---|
listCompleted | boolean | |
items | Contact[] |
Update contact
Update contact
updateContactPATCH
/contact/{tenantLocator}/contacts/{locator}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
locator | path | ulid | Yes |
ContactUpdateRequest
Required properties
| Property | Type | Description |
|---|---|---|
removeData | map<string, object> | |
setData | map<string, object> |
Optional properties
| Property | Type | Description |
|---|---|---|
region | string? | |
type | string? |
Validate contact
Validate contact
validateContactPATCH
/contact/{tenantLocator}/contacts/{locator}/validateParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
locator | path | ulid | Yes |
Response:
ContactSecurity Group:
contactsPermission:
writeMerge contacts
Merge contacts
mergeContactsPATCH
/contact/{tenantLocator}/contacts/mergeParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes |
ContactsMergeRequest
Required properties
| Property | Type | Description |
|---|---|---|
mergeToContact | ulid | |
contactLocators | ulid[] |