For the complete documentation index, see llms.txt. This page is also available as Markdown.

Create or Update Contact

Create new contact

post

Create a new or update contact in the system. To update existing contact, provide the user_id or the same email & firstname, or phone & firstname. In addition to the attributes listed below, you can add any custom attributes to the contact.

Header parameters
X-API-KEYstringRequired

Your API key

X-SECRET-KEYstringRequired

Your Secret key

Body
app_idstringRequired
first_namestringRequired
last_namestringRequired
emailstring · emailOptional
phonestringOptional
addressstringOptional
citystringOptional
statestringOptional
zipstringOptional
sourcestringOptional
user_idstringOptional
dobstring · dateOptional

YYYY-MM-DD

created_datestring · date-timeOptional

YYYY-MM-DD HH:MM:SS

genderstringOptional
typestringOptional

eg. member, past, prospect

statusstringOptional

eg. active, inactive, non-member etc

locationstringOptional
optin_smsbooleanOptional
optout_emailbooleanOptional
tagsstringOptional

comma separated tags

tag_actionstringOptional

add or remove

Responses
200

Contact created successfully

application/json
statusstringOptionalExample: success
_idstringOptional
post
/v2/ExternalApi/newContact

Last updated