Skip to main content
POST
/
contacts
Create or upsert contact
curl --request POST \
  --url https://api.getoutbox.ai/contacts/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "full_name": "<string>",
  "email": "<string>",
  "phone_number": "<string>",
  "business_name": "<string>",
  "notes": "<string>",
  "tags": [
    "<string>"
  ],
  "is_dnd": true,
  "lead_source": "<string>",
  "custom_fields": {}
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.getoutbox.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Company API Key

Body

application/json

Contact fields

​
full_name
string

Title-cased; split into first and last name

​
email
string

Lowercased; optional

​
phone_number
string

Normalized using the company's country when present

​
business_name
string
​
notes
string
​
tags
string[]

On an existing contact, new tags are merged with existing tags (deduplicated)

​
is_dnd

Do-not-disturb; boolean or string variants accepted

​
lead_source
string

Must be one of: manual, api, webhook, facebook, instagram, import. Invalid values are stored as manual.

​
custom_fields
object

Map of custom field name to value (string). Only keys that exist as company CustomField names are stored.

Response

Success. Empty response body (no JSON payload).