Skip to main content
POST
/
api
/
contacts.upsert
Create or update a contact
curl --request POST \
  --url https://{notifuseDomain}/api/contacts.upsert \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspace_id": "ws_1234567890",
  "contact": {
    "email": "user@example.com",
    "external_id": "user_12345",
    "timezone": "America/New_York",
    "language": "en-US",
    "first_name": "John",
    "last_name": "Doe",
    "full_name": "John Doe",
    "phone": "+15551234567",
    "address_line_1": "123 Main St",
    "address_line_2": "Apt 4B",
    "country": "US",
    "postcode": "10001",
    "state": "NY",
    "job_title": "Software Engineer",
    "custom_string_1": "Premium tier",
    "custom_string_2": "<string>",
    "custom_string_3": "<string>",
    "custom_string_4": "<string>",
    "custom_string_5": "<string>",
    "custom_number_1": 42,
    "custom_number_2": 123,
    "custom_number_3": 123,
    "custom_number_4": 123,
    "custom_number_5": 123,
    "custom_datetime_1": "2023-06-01T09:00:00Z",
    "custom_datetime_2": "2023-11-07T05:31:56Z",
    "custom_datetime_3": "2023-11-07T05:31:56Z",
    "custom_datetime_4": "2023-11-07T05:31:56Z",
    "custom_datetime_5": "2023-11-07T05:31:56Z",
    "custom_json_1": {
      "preferences": {
        "theme": "dark",
        "notifications": true
      }
    },
    "custom_json_2": {},
    "custom_json_3": {},
    "custom_json_4": {},
    "custom_json_5": {}
  }
}
'
{
  "email": "user@example.com",
  "action": "create",
  "error": null
}

Authorizations

​
Authorization
string
header
required

API token for authentication

Body

application/json
​
workspace_id
string
required

The ID of the workspace

Example:

"ws_1234567890"

​
contact
object
required

Response

Contact upserted successfully

​
email
string<email>

Email address of the contact

Example:

"user@example.com"

​
action
enum<string>

The action that was performed: 'create' for new contacts, 'update' for existing contacts, 'error' if validation failed

Available options:
create,
update,
error
Example:

"create"

​
error
string | null

Error message if the operation failed

Example:

null