Campaign contacts

List the contacts of a campaign

Paginated contacts of a campaign with their status in the campaign. page is ZERO based. perPage below 10 is replaced by 20; maximum 10,000.

get/advanced/campaign/contacts

Request

  • Base URL: https://api.emelia.io
  • URL: https://api.emelia.io/advanced/campaign/contacts
  • Auth: API key in header Authorization

Query parameters

idstring required

MongoDB ObjectId: 24 hexadecimal characters.

Example:6650f1a2b839d80011c5a0f1

Campaign id.

pageinteger required

Zero based page index.

perPageinteger
string
OR
string[]

Filter on contact status (for example SENT, MAIL_REPLIED; NO_ACTIVITY = no activity yet). Send it as an array: event[]=SENT or repeat the parameter. A single plain event=SENT is accepted by validation but currently fails with a 400 error.

querystring

Exact email, or words matched against email, names, phone and LinkedIn URL.

Response

Success.

successunknown
countinteger
_idstring

Campaign id.

Example response

{
  "list": [
    {
      "_id": "6650f1a2b839d80011c5a0f1"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.