Update the account's tracking settings
https://email.growthdept.ai/api/tracking-settings/{id}The request body can be up to 5 MB.
Rate limits
Scopes
tracking-settings:write
Operation id
update_tracking_setting The same operation as in Klaviyo's API. OpenAPI document
Path parameters
stringrequired
Query parameters
Pick values to add them to the request:
Body
Send application/vnd.api+json or application/json.
object
dataobjectrequired
data: 5 fields
typestringrequired
tracking-settingidstringrequired
attributesobjectrequired
attributes: 7 fields
auto_add_parametersbooleancan be null
utm_sourceobject
utm_source: 2 fields
campaignobject
campaign: 2 fields
typestringrequired
staticdynamicvaluestringrequired
flowobject
flow: 2 fields
typestringrequired
staticdynamicvaluestringrequired
utm_mediumobject
utm_medium: 2 fields
campaignobject
campaign: 2 fields
typestringrequired
staticdynamicvaluestringrequired
flowobject
flow: 2 fields
typestringrequired
staticdynamicvaluestringrequired
utm_campaignobject
utm_campaign: 2 fields
campaignobject
campaign: 2 fields
typestringrequired
staticdynamicvaluestringrequired
flowobject
flow: 2 fields
typestringrequired
staticdynamicvaluestringrequired
utm_idobject
utm_id: 2 fields
campaignobject
campaign: 2 fields
typestringrequired
staticdynamicvaluestringrequired
flowobject
flow: 2 fields
typestringrequired
staticdynamicvaluestringrequired
utm_termobject
utm_term: 2 fields
campaignobject
campaign: 2 fields
typestringrequired
staticdynamicvaluestringrequired
flowobject
flow: 2 fields
typestringrequired
staticdynamicvaluestringrequired
custom_parametersarray of objects
custom_parameters: 3 fields
campaignobject
campaign: 2 fields
typestringrequired
staticdynamicvaluestringrequired
flowobject
flow: 2 fields
typestringrequired
staticdynamicvaluestringrequired
namestringrequired
relationshipsobject
metaobject
Edit the example. The code samples use what you type here.
Headers
stringrequireddefault 2026-10-15
API revision, YYYY-MM-DD. This server implements 2026-10-15.
Responses
200Success
Response body
object
dataobjectrequired
data: 4 fields
typestringrequired
tracking-settingidstringrequired
attributesobjectrequired
attributes: 7 fields
auto_add_parametersbooleanrequired
utm_sourceobjectrequired
utm_source: 2 fields
flowone ofcan be null
One option: FlowTrackingSettingDynamicParam
typestringrequired
dynamicvaluestringrequired
email_subjectflow_idflow_namelink_alt_textmessage_namemessage_name_idmessage_typeprofile_external_idprofile_id
One option: FlowTrackingSettingStaticParam
typestringrequired
staticvaluestringrequired
campaignone ofcan be null
One option: CampaignTrackingSettingDynamicParam
typestringrequired
dynamicvaluestringrequired
Show 13 allowed values
campaign_idcampaign_namecampaign_name_idcampaign_name_send_dayemail_subjectgroup_idgroup_namegroup_name_idlink_alt_textmessage_typeprofile_external_idprofile_idvariation_name
One option: CampaignTrackingSettingStaticParam
typestringrequired
staticvaluestringrequired
utm_mediumobjectrequired
utm_medium: 2 fields
flowone ofcan be null
One option: FlowTrackingSettingDynamicParam
typestringrequired
dynamicvaluestringrequired
email_subjectflow_idflow_namelink_alt_textmessage_namemessage_name_idmessage_typeprofile_external_idprofile_id
One option: FlowTrackingSettingStaticParam
typestringrequired
staticvaluestringrequired
campaignone ofcan be null
One option: CampaignTrackingSettingDynamicParam
typestringrequired
dynamicvaluestringrequired
Show 13 allowed values
campaign_idcampaign_namecampaign_name_idcampaign_name_send_dayemail_subjectgroup_idgroup_namegroup_name_idlink_alt_textmessage_typeprofile_external_idprofile_idvariation_name
One option: CampaignTrackingSettingStaticParam
typestringrequired
staticvaluestringrequired
utm_campaignobjectcan be null
utm_campaign: 2 fields
flowone ofcan be null
One option: FlowTrackingSettingDynamicParam
typestringrequired
dynamicvaluestringrequired
email_subjectflow_idflow_namelink_alt_textmessage_namemessage_name_idmessage_typeprofile_external_idprofile_id
One option: FlowTrackingSettingStaticParam
typestringrequired
staticvaluestringrequired
campaignone ofcan be null
One option: CampaignTrackingSettingDynamicParam
typestringrequired
dynamicvaluestringrequired
Show 13 allowed values
campaign_idcampaign_namecampaign_name_idcampaign_name_send_dayemail_subjectgroup_idgroup_namegroup_name_idlink_alt_textmessage_typeprofile_external_idprofile_idvariation_name
One option: CampaignTrackingSettingStaticParam
typestringrequired
staticvaluestringrequired
utm_idobjectcan be null
utm_id: 2 fields
flowone ofcan be null
One option: FlowTrackingSettingDynamicParam
typestringrequired
dynamicvaluestringrequired
email_subjectflow_idflow_namelink_alt_textmessage_namemessage_name_idmessage_typeprofile_external_idprofile_id
One option: FlowTrackingSettingStaticParam
typestringrequired
staticvaluestringrequired
campaignone ofcan be null
One option: CampaignTrackingSettingDynamicParam
typestringrequired
dynamicvaluestringrequired
Show 13 allowed values
campaign_idcampaign_namecampaign_name_idcampaign_name_send_dayemail_subjectgroup_idgroup_namegroup_name_idlink_alt_textmessage_typeprofile_external_idprofile_idvariation_name
One option: CampaignTrackingSettingStaticParam
typestringrequired
staticvaluestringrequired
utm_termobjectcan be null
utm_term: 2 fields
flowone ofcan be null
One option: FlowTrackingSettingDynamicParam
typestringrequired
dynamicvaluestringrequired
email_subjectflow_idflow_namelink_alt_textmessage_namemessage_name_idmessage_typeprofile_external_idprofile_id
One option: FlowTrackingSettingStaticParam
typestringrequired
staticvaluestringrequired
campaignone ofcan be null
One option: CampaignTrackingSettingDynamicParam
typestringrequired
dynamicvaluestringrequired
Show 13 allowed values
campaign_idcampaign_namecampaign_name_idcampaign_name_send_dayemail_subjectgroup_idgroup_namegroup_name_idlink_alt_textmessage_typeprofile_external_idprofile_idvariation_name
One option: CampaignTrackingSettingStaticParam
typestringrequired
staticvaluestringrequired
custom_parametersarray of objectscan be null
custom_parameters: 3 fields
flowone ofcan be null
One option: FlowTrackingSettingDynamicParam
typestringrequired
dynamicvaluestringrequired
email_subjectflow_idflow_namelink_alt_textmessage_namemessage_name_idmessage_typeprofile_external_idprofile_id
One option: FlowTrackingSettingStaticParam
typestringrequired
staticvaluestringrequired
campaignone ofcan be null
One option: CampaignTrackingSettingDynamicParam
typestringrequired
dynamicvaluestringrequired
Show 13 allowed values
campaign_idcampaign_namecampaign_name_idcampaign_name_send_dayemail_subjectgroup_idgroup_namegroup_name_idlink_alt_textmessage_typeprofile_external_idprofile_idvariation_name
One option: CampaignTrackingSettingStaticParam
typestringrequired
staticvaluestringrequired
namestringrequired
linksobjectrequired
links: 1 field
selfstring (uri)required
linksobject
links: 1 field
selfstring (uri)required
metaobject
4XXClient error
Response body
object
errorsarray of objectsrequired
errors: 8 fields
idstringrequired
statusintegerrequired
codestringrequired
titlestringrequired
detailstringrequired
sourceobject
source: 2 fields
pointerstring
parameterstring
linksobject
metaobject
See status codes for each code.
5XXServer error
Response body
object
errorsarray of objectsrequired
errors: 8 fields
idstringrequired
statusintegerrequired
codestringrequired
titlestringrequired
detailstringrequired
sourceobject
source: 2 fields
pointerstring
parameterstring
linksobject
metaobject