Skip to main content

Voyado Engage

Check if contact exists

If all you need to do is check if a certain contact exists, there is an endpoint for this purpose:

https://[client].voyado.com/api/v2/contacts/id

To this endpoint you can send, along with contactType, one (or several) of the following parameters:

email

https://[client].voyado.com/api/v2/contacts/id?contactType=member&email=john.doe%40gmail.com

mobilePhone

https://[client].voyado.com/api/v2/contacts/id?contactType=member&mobilePhone=%2B46735654321

socialSecurityNumber

Although it's called socialSecurityNumber (sometimes SSN) in Engage, this is really the Swedish personal identity number (or the Finnish personal identity code). Keep this in mind.

https://[client].voyado.com/api/v2/contacts/id?contactType=member&socialSecurityNumber=196903027573

customKey

As the customKey value you can send either a contact's memberNumber or externalId, depending on how your tenant is set up. Your Voyado Engage team can help you here.

https://[client].voyado.com/api/v2/contacts/id?contactType=member&customKey=999888777

any

The "any" parameter will, as the name suggests, accept any of the above values. They are scanned in the following order: email, socialSecurityNumber, mobilePhone and then customKey.

For example:

https://[client].voyado.com/api/v2/contacts/id?contactType=member&any=john.doe%40gmail.com

https://[client].voyado.com/api/v2/contacts/id?contactType=member&any=999888777

Response body

If the request has been successful, you'll get a response HTTP 200 OK and the contact's unique id returned as a 32-bit GUID.

Response codes

If the request has not been successful, you'll get one of the following HTTP error codes:

  • 400: InvalidEmailAddress, InvalidPhoneNumber, InvalidSocialSecurityNumber, InvalidContactType, InvalidSearchQuery

  • 404: ContactNotFound

  • 409: MultipleMatches

  • 500: InvalidSystemConfiguration

Note

Response codes could change, so always check your Swagger page to see the latest ones.