Campaigns

Get a campaign

Returns the full campaign: schedule (settings), sequence tree (steps), identities, attached lists with their contact count, status and dates. Read it before any PATCH: the steps and settings routes replace what you send.

get/advanced/campaigns/{campaignId}

Request

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

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.