POST /contacts/v1/establish
Creates or returns a contact using the Contact Key and Contact Type provided in the payload.
Name | Type | Description |
---|---|---|
contactKeys | array | Required. String array of one or more contact keys. |
contactType | number | The default contact type is Default or 0 . Most users do not modify the default value. |
returnResults | boolean | Indicates if the call returns results. The default value is true . |
correlateResponseItem | boolean | Indicates if the result items' return order matches the request order. The default value is true . |
includeNewContactAwareness | boolean | Indicates that the contact has never been included in the results before. The default value is false . |
Status | Name | Type | Description |
---|---|---|---|
200 | Successfully Established Contact | ||
items | array | An array of contact result objects for the requested contacts to be established. | |
items.value | object | The Contact result returned | |
items.value.requestedContactKey | string | The requested Contact Key | |
items.value.isNewContact | boolean | Returns if the Contact was newly created. Only is returned when includeNewContactAwareness=true | |
items.value.contactReference | object | The Contact reference returned | |
items.value.contactReference.contactID | long | The established Contact's ID | |
items.value.contactReference.contactType | string | The established Contact's Type | |
items.value.contactReference.contactKey | string | The established Contact's Type | |
items.value.contactReference.contactStatus | string | The established Contact's Status | |
items.value.requestItemIndex | int | The Contact reference's index in the Request | |
items.value.resultMessages | array | An array of result messages related to this Contact | |
requestServiceMessageID | guid | Service message ID for the request | |
responseDateTime | datetime | The time the Response was created | |
resultMessages | array | An array of result messages | |
serviceMessageID | guid | Service message ID for the Response |
This action requires these permissions.
- Contact Builder, Administer Contact Data Model
- Contact Builder, Access