Contacts API

Endpoint Index

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

addContact

POST /contact/{tenantLocator}/contacts

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required

Request:ContactCreateRequest
Response:Contact
Security Group:contacts   Permission:write

ContactCreateRequest

required
autoValidate boolean
type string
data map<string,object>

optional
region string?

Contact

required
locator string
staticLocator string
contactState Enum draft | validated | discarded
type string
data map<string,object>
createdAt datetime
createdBy uuid

optional
region string?
updatedAt datetime?
updatedBy uuid?
validationResult ValidationResult?

Fetch contact

getContact

GET /contact/{tenantLocator}/contacts/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:Contact
Security Group:contacts   Permission:read

Lookup contact

lookupContact

GET /contact/{tenantLocator}/contacts/lookup/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:Contact
Security Group:contacts   Permission:read

List contacts

listContacts

GET /contact/{tenantLocator}/contacts/{staticLocator}/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
staticLocator	path	string	required
offset	query	int?	optional
count	query	int?	optional

Response:ListPageResponseContact
Security Group:contacts   Permission:read

ListPageResponseContact

required
listCompleted boolean
items Contact[]

Update contact

updateContact

PATCH /contact/{tenantLocator}/contacts/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Request:ContactUpdateRequest
Response:Contact
Security Group:contacts   Permission:write

ContactUpdateRequest

required
removeData map<string,object>
setData map<string,object>

optional
region string?
type string?

Validate contact

validateContact

PATCH /contact/{tenantLocator}/contacts/{locator}/validate

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:Contact
Security Group:contacts   Permission:write

Merge contacts

mergeContacts

PATCH /contact/{tenantLocator}/contacts/merge

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required

Request:ContactsMergeRequest
Response:Contact
Security Group:contacts   Permission:write

ContactsMergeRequest

required
mergeToContact string
contactLocators string[]