HomeGuidesAPI Reference
Need Help?
API Reference
Need Help?

Update campaign UTM settings

put
https://api.omnisend.com/api/campaigns//utm

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.

Path Params
string
required

Campaign ID (24 character hexadecimal)

Body Params

UTM update data — use tags for regular campaigns, variants for A/B test campaigns

UTM update request. Provide tags for regular campaigns or variants for A/B test campaigns. Exactly one must be present; providing both is a validation error.

tags
object

UTM tag values. Providing empty values resets them to defaults.

variants
object

UTM variant update entries for an A/B test campaign.

Headers
string
required
Defaults to 2026-preview

API version that specifies the response format and behaviour

Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?