Skip to Content
SendlySendly
API ReferenceContacts

Create a contact

POST
/api/contacts

Create a new contact. Returns 409 on (projectId, email) conflict — use /api/contacts/upsert for create-or-update semantics.

Requires the contacts:write scope — Create, update, and delete your contacts.

headerAuthorizationBearer <API Key>

API key authentication. Use a sk_* (FULL) or pk_* (SENDING_ONLY) key as the bearer token. Public keys (pk_*) are restricted to the email-send endpoints and the self-serve list subscribe/unsubscribe pair; every other endpoint — event tracking included — answers 403 for them. In scope terms (used by /api/v1/* operations): FULL keys hold every scope; SENDING_ONLY keys hold only emails:send.

application/json
  1. body

Body for POST /api/contacts and /api/contacts/upsert.

email*string
Formatemail
subscribed?boolean
Defaulttrue
customFields?

Arbitrary JSON value (string, number, boolean, null, array, or object).

Response Body

Contact created

application/json
  1. response
success*true
Value intrue
data*

A subscriber/contact within a project.

Example Request
curl -X POST 'https://api.sendly.now/api/contacts' \  -H 'Content-Type: application/json' \  -d '{  "email": "user@example.com"}'
Example Response
{  "success": true,  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",    "email": "user@example.com",    "subscribed": true,    "customFields": {      "property1": null,      "property2": null    },    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}