OMomnisend
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

Rate Limiting: This endpoint is rate limited to 400 requests per minute.

put/campaigns/{id}/utm

Request

  • Base URL
    https://api.omnisend.com/api
  • URL
    https://api.omnisend.com/api/campaigns/{id}/utm
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://app.omnisend.com/oauth2/token scopes: campaigns.write
    • or API key in header Authorization

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": "Welcome Email",
    "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": "Welcome Email",
    "medium": "email",
    "source": "omnisend"
  },
  "variants": {
    "a": {
      "id": "000000000000000000000010",
      "tags": {
        "campaign": "Welcome Email",
        "medium": "email",
        "source": "omnisend"
      }
    },
    "b": {
      "id": "000000000000000000000010",
      "tags": {
        "campaign": "Welcome Email",
        "medium": "email",
        "source": "omnisend"
      }
    }
  }
}

Changes

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