latestOpenAPI 3.0.12026-08-21183382785.0 KB

24caa8eb809b

Tokens

Update Profiles API token (legacy)

Update a Profiles API token. <br> <br> <br> This endpoint is for Audience Studio legacy. For the latest Audience Studio, contact your Customer Success Representative.

put/audiences/{audienceId}/tokens/{tokenId}

Path parameters

audienceIdinteger required

Master Segment ID of the token

tokenIdinteger required

ID of Token to return

Request body

descriptionstring

description

tokenstring uuid

UUID of the token

keyColumnstring required

A key column name to fetch the information of a customer.

attributeColumnsstring[] required

associated attribute column names. Max the number of attribute columns is 5. You must specify empty array if you don't need attributes.

Example request

{
  "description": "description",
  "keyColumn": "td_client_id",
  "segments": [
    {
      "id": 1234
    }
  ],
  "attributeColumns": [
    "gender",
    "country"
  ]
}

Response

successful operation

idstring integer
audienceIdstring integer
tokenstring uuid

UUID of the token

descriptionstring
keyColumnstring

A key column name to fetch the information of a customer.

attributeColumnsstring[]

associated attribute column names.

v2boolean

whether the token is v2 or not

createdAtstring date-time
updatedAtstring date-time

Example response

{
  "keyColumn": "td_client_id",
  "attributeColumns": [
    "gender",
    "country"
  ],
  "v2": true
}