v1

latestOpenAPI 3.0.02026-07-2664192238.8 KB
Campaigns

Update campaign UTM settings

Replace UTM tag settings for a campaign. For regular campaigns send a tags object. For A/B test campaigns send a variants object. The campaign must be in draft status.

Scopes: campaigns.write

put/campaigns/{id}/utm

Path parameters

idstring required

Campaign ID (24 character hexadecimal)

Headers

Omnisend-Versionstring required

API version that specifies the response format and behaviour

Request body

Example request

{
  "tags": {
    "campaign": "automation: Welcome Series (000000000000000000000001)",
    "medium": "email",
    "source": "omnisend"
  },
  "variants": {
    "a": {
      "campaign": "Welcome A",
      "medium": "email",
      "source": "omnisend"
    },
    "b": {
      "campaign": "Welcome A",
      "medium": "email",
      "source": "omnisend"
    }
  }
}

Response

Updated UTM settings

Example response

{
  "tags": {
    "campaign": "automation: Welcome Series (000000000000000000000001)",
    "medium": "email",
    "source": "omnisend"
  }
}