Docs

Add a contact to an email list

Guide: Email campaigns

Deprecated

POST
/emails/lists/contacts

Adds one contact to an existing contact list (id = list ObjectId). Any extra key in contact is stored as a custom variable. Fails if the email is already in the list. New integrations should use the multichannel /advanced campaign endpoints instead.

Authorization

apiKey
Authorization<token>

Your 48 character API key, sent as is (a Bearer prefix is tolerated). Create it at https://v3.emelia.io/settings/api.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/emails/lists/contacts" \  -H "Authorization: YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "id": "5f3a1b2c4d5e6f0011223366",    "contact": {      "email": "john.doe@acme.com",      "firstName": "John"    }  }'
{  "success": true}

DELRemove a contact

Removes the contact whose email matches from the campaign (id).

GETList campaigns

Returns non-archived email campaigns with a reduced field set (_id, name, status, createdAt, startAt, useManyProviders, providersUsed, plannedStart) and the populated provider.