Skip to content

Upsert a contact

POST
/api/v1/contacts/upsert
curl --request POST \
--url https://renotify.app/api/v1/contacts/upsert \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "external_id": "contact_123", "source": "hubspot", "name": "Jane Doe", "phone": "+15551234567", "email": "jane@example.com", "data": { "city": "Boston" }, "marketing_consent": { "whatsapp": true, "email": false } }'

Create or update a contact, deduplicating by phone number within the team.

Media typeapplication/json
object
external_id

The external system identifier.

string
nullable
Example
contact_123
source

The source system name.

string
Example
hubspot
name
required

The contact name.

string
Example
Jane Doe
phone

The contact phone number.

string
nullable
Example
+15551234567
email

The contact email address.

string
nullable
Example
jane@example.com
data

Additional custom field values.

object
Example
{
"city": "Boston"
}
marketing_consent

Marketing consent per channel (whatsapp, sms, email, rcs, telegram, messenger, instagram, browser_push). Omitted channels are unchanged.

object
Example
{
"whatsapp": true,
"email": false
}