SendLit logoSendLit Docs
API ReferenceContacts

Create a contact

Creates a contact (subscriber). If a contact with the same email already exists for this team, the existing contact is returned.

POST
/contacts

Creates a contact (subscriber). If a contact with the same email already exists for this team, the existing contact is returned.

Authorization

x-sendlit-apikey<token>

In: header

Request Body

application/json

Body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://api.sendlit.dev/contacts" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com"  }'
{
  "contactId": "string",
  "email": "string",
  "name": "string",
  "subscribed": true,
  "customFields": {},
  "tags": [
    "string"
  ],
  "unsubscribeToken": "string",
  "createdAt": "string",
  "updatedAt": "string"
}

List contacts GET

Returns a paginated list of contacts. Pass filter as serialized ContactFilterWithAggregator JSON for inline filtering, or segmentId to only return contacts currently matching that saved segment's filter (404 if the segment doesn't exist). SendLit supports fixed generic contact filters over first-class fields, tags, and custom fields; client-specific concepts should be synced into namespaced tags or customFields. q, filter, and segmentId combine with AND. The response's total reflects the combined filters.

Delete a contact DELETE

Next Page