COconversion

Get Campaign

Get a custom campaign by id, including its description and its campaign type's member statuses as type.statuses. Statuses are returned in the type's configured progression order. Archived campaigns return 404.

get/v2/campaigns/{campaignId}

Request

  • Base URL
    https://pub-api.conversion.ai/api
  • Auth
    • API key in header X-API-Key
    • or API key in query parameter api_key

Path parameters

campaignIdstring uuid required

The Conversion campaign id, as returned by GET /v2/campaigns.

Response

Campaign retrieved successfully.

Example response

{
  "data": {
    "campaign": {
      "id": "b7c8d9e0-f1a2-3456-bcde-f01234567890",
      "name": "Q3 Field Events",
      "type": {
        "id": "3c9d2b1a-8e4f-4a6b-9c0d-2e3f4a5b6c7d",
        "name": "Field Event",
        "statuses": [
          {
            "name": "Attended"
          }
        ]
      },
      "sfdcCampaignId": "701Ho00000AbCdEfGH",
      "memberCount": 42,
      "description": "Events run by the field team"
    }
  }
}

Changes

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