Campaigns

Set the sender identities

Replaces the identities (sending accounts) of the campaign. Not allowed while RUNNING. For each step Emelia picks automatically, among these identities, the least used one that has an account on the channel. Rules checked at start: every identity needs an email provider if the sequence has an email step; with a LinkedIn step either use a single LinkedIn account or attach one to every identity.

patch/advanced/campaigns/{campaignId}/identities

Request

  • Base URL: https://api.emelia.io
  • URL: https://api.emelia.io/advanced/campaigns/{campaignId}/identities
  • 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

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.