OMomnisend
Automations

Update UTM tags for an automation block

Set UTM tracking tags for a specific send-action block. All three tag fields are replaced atomically. Send an empty string to clear a field — the next read will return its default value.

Scopes: automations.write

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

put/automations/{id}/blocks/{blockID}/utm

Request

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

Path parameters

idstring required

Automation workflow ID (24 character hexadecimal)

blockIDstring required

Block identifier

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"
  }
}

Response

Updated UTM tags (with defaults applied)

Example response

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

Changes

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