Get Contact by External ID

get

https://api.sisu.co/api/v1/contact/external

Gets a contact by an external ID at a specific external service.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

external_contact_id

string

required

The ID of the contact in the external service.

external_service_id

enum

required

The ID of the external service that the external_contact_id comes from.

allowed_statuses

string

required

Only return a contact that has a status equal to the defined status. This parameter may be specified multiple times to specify multiple allowed statuses. Defaults to allowing 'N' or 'D' when no parameter is given.

fallback_email

string

The contact email address to search for if a contact is not found with a matching external_contact_id and external_service_id. This is useful for locating contacts that already exist in the system without external ID mappings.

save_mapping_on_fallback

boolean

Whether or not to automatically create a mapping after a fallback search successfully locates a contact. This option only works when combined with the fallback_email parameter. This setting lets you effectively use this one request to search for a contact by an ID, search by email (if not found), and then save the mapping to the system (if missing). Defaults to false.

Responses

200Success

500Error