Campaigns

Set the contact lists of a campaign

Sets the FULL selection of lists (replace semantics): the campaign contacts become the contacts of lists, minus any contact whose email or LinkedIn URL appears in one of excludedLists. When excludedLists is omitted the current exclusion lists are kept. Allowed on a running campaign. A campaign cannot be started with more than 30,000 recipients. Create and fill lists with the Lists endpoints (/lists/...).

patch/advanced/campaigns/{campaignId}/recipients

Request

  • Base URL: https://api.emelia.io
  • URL: https://api.emelia.io/advanced/campaigns/{campaignId}/recipients
  • Auth: API key in header Authorization

Path parameters

campaignIdstring required

MongoDB ObjectId: 24 hexadecimal characters.

Example:6650f1a2b839d80011c5a0f1

Identifier of a multichannel campaign (24 hexadecimal characters), as returned by POST /advanced/campaigns or GET /advanced/campaigns.

Request body

listsObjectId[] required

Ids of the lists to use.

excludedListsObjectId[]

Ids of exclusion lists.

Example request

{
  "lists": [
    "6650f1a2b839d80011c5a0f1"
  ],
  "excludedLists": [
    "6650f1a2b839d80011c5a0f1"
  ]
}

Response

Success.

successunknown

Example response

{
  "campaign": {
    "_id": "6650f1a2b839d80011c5a0f1",
    "tagIds": [
      "6650f1a2b839d80011c5a0f1"
    ],
    "identities": [
      {
        "_id": "6650f1a2b839d80011c5a0f1",
        "userId": "6650f1a2b839d80011c5a0f1",
        "email": "6650f1a2b839d80011c5a0f1",
        "linkedin": "6650f1a2b839d80011c5a0f1",
        "whatsapp": "6650f1a2b839d80011c5a0f1"
      }
    ],
    "recipients": {
      "lists": [
        {
          "_id": "6650f1a2b839d80011c5a0f1"
        }
      ],
      "excludedLists": [
        {
          "_id": "6650f1a2b839d80011c5a0f1"
        }
      ]
    },
    "zapierData": [
      {
        "_id": "6650f1a2b839d80011c5a0f1"
      }
    ]
  }
}

Changes

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