iQ Variables API

To learn more about this API and available object fields, see iQ Profiles API and iQ Profiles Objects.

How it works

Use the PATCH method to create, update, and delete variables in the iQ Profile object.

PATCH /v3/tiq/accounts/{ACCOUNT}/profiles/{PROFILE}

When you use the PATCH method you are making changes to your profile variables programmatically using a save or save-as. After making changes with the API you must still log into the application to publish.

Example cURL request

curl --location --request PATCH 'https://platform.tealiumapis.com/v3/tiq/accounts/{account}/profiles/{profile}' \
  --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzUx...MiJ9' \
  --header 'Content-Type: application/json' \
  --data '

Authentication

The bearer token is used to authenticate all API calls and not the API key. The API key is only used in the authentication call. In addition to the bearer token, the authentication response includes a region-specific hostname that must be used in subsequent server-side API calls.

See the Tealium API V3 Getting Started guide to learn about generating a bearer token from the API key.

Profile fields

Profile variables are JSON objects that contain the following possible fields:

Example request

{
  "versionTitle":"Version 2022.03.22.2108",
  "saveType": "saveAs",
  "notes": "version notes here",
  "operationList":[
    {
      "op":"add",
      "path":"/variables",
      "value":{
        "object": "variable",
        "name": "viewport_height",
        "alias": "Viewport Height",
        "type": "dom",
        "notes":"dom variable"
      }
    }
  ]
}

PATCH operation parameters

Instead of POST, PUT, and DELETE methods, the PATCH method uses the op parameter to specify the action to perform.

The op parameter supports the following values:

• add - Create the component.
• replace - Update the component.
• remove - Delete the component.

To specify the the type and ID of the component, use the path parameter. The path parameter format is /{TYPE}/{ID}.

For example, to add a variable use:

"op" : "add",
"path" : "/variables"

To update a specific variable, add the ID to the path:

"op" : "replace",
"path" : "/variables/503"

Create variable

This PATCH method takes a profile variable object and additional variable fields.

Example request

{
  "versionTitle":"Version 2022.03.22.2108",
  "saveType": "saveAs",
  "notes": "version notes here",
  "operationList":[
    {
      "op":"add",
      "path":"/variables",
      "value":{
        "object": "variable",
        "name": "viewport_height",
        "alias": "Viewport Height",
        "type": "dom",
        "notes":"dom variable"
      }
    }
  ]
}

Update variable

This PATCH method takes a profile variable object and additional variable fields.

Example request

{
  "versionTitle":"Version 2022.03.22.2108",
  "saveType": "saveAs",
  "notes": "version notes here",
  "operationList":[
    {
      "op":"replace",
      "path":"/variables/503",
      "value":{
        "object": "variable",
        "name": "viewport_height",
        "alias": "Viewport Height",
        "type": "dom",
        "notes":"dom variable"
      }
    }
  ]
}

Delete variable

This PATCH method takes a profile variable object and additional variable fields.

Example request

{
  "versionTitle":"Version 2022.03.22.2108",
  "saveType": "saveAs",
  "notes": "version notes here",
  "operationList":[
    {
      "op":"remove",
      "path":"/variables/503",
      "value":{
        "object": "variable"
      }
    }
  ]
}

Error messages

Potential error messages for this endpoint: