Find or Create a Contact
Attempts to find and return a contact using the email address or mobile number. If a contact is not found, a new contact is created.
This API is similar to the Get a Contact API, but creates a new contact if a contact is not found.
How this API is used:
Find or create by email address /api/v1/contact/upsert?email=ben@example.com
Find or create by mobile phone /api/v1/contact/upsert?mobilephone=+155512345678
Email address to look up. Either email or mobilephone must be provided.
Mobile phone number to look up (E.164 format recommended). Either email or mobilephone must be provided.
{
"Status": true,
"Message": "",
"Response": {
"contact": {
"tenantId": 112,
"dsId": "5a0d669ab6984125a1c63aaacfd0a9cd",
"firstName": "",
"lastName": "",
"email": "ben@example.com",
"mobilePhone": "",
"status": "Active",
"donotcontact": false,
"optOutEmail": false,
"optOutSms": false,
"isEmailEnabled": true,
"isSmsEnabled": true,
"dateContactCreated": "2026-04-20T12:00:00",
"dateContactLastModified": "2026-04-20T12:00:00"
}
}
}
The contact record that was found or newly created. Same shape as the object returned by Get a Contact — includes dsId, name, email, mobilePhone, subscription flags, location, and extendedProperties.