Add/update contacts

post

https://yespo.io/api/v1/contacts

The method adds new contacts and updates existing contacts. Asynchronous processing is used; requests may be handled in a different order or concurrently.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

contacts

array of objects

required

The list of contacts that will be added or updated (max. 3000).
If this array of objects contains externalCustomerId, the search uses externalCustomerId and ignores dedupeOn.

contacts*

dedupeOn

string

enum

required

The field for determining the contact uniqueness. Important the field set as dedupeOn will not be updated

Allowed:

fieldId

int64

The field for determining the contact uniqueness. This field is taken into account when dedupeOnProperty has the fieldId value.

contactFields

array of strings

enum

The list of contacts’ fields to be updated. All the contact fields will be updated if this parameter is not specified. The fields will be updated with the ‘null’ value if no data for updating is transmitted.

contactFields

customFieldsIDs

array of int32s

The list of the custom field IDs to be updated.
The custom fields are updated if their IDs are in this list.
This field is required when a contact is updated

customFieldsIDs

groupNames

array of strings

The list of the segment names where the new/updated contacts will be added to.

groupNames

groupNamesExclude

array of strings

The list of the segment names where the new/updated contacts will be excluded from.

groupNamesExclude

restoreDeleted

boolean

Choose either to restore the previously deleted contacts or not.

eventKeyForNewContacts

string

The event type identification key. An event of corresponding type is generated for each contact.
If the system does not have an event type with such a key, a new event type is created.
All characters are allowed, except < ; ’ \ / | " ` ' ^ ? ! , >
Max length: 100 symbols

Responses

400

Bad request

401

Unauthorized

405

Method not allowed

415

Unsupported media type

429

Too many requests: More than 200 requests per 1 second