Skip to content
Documentation

Update Personalization Tag

PATCH
/api/v1/workspaces/{workspace_id}/personalization_tags/{id}
curl --request PATCH \
  --url https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/personalization_tags/1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "label": "First name", "default_value": "{{firstName}}", "example_value": "John", "dynamic_content_profile_values": { "a1b2c3d4-5678-90ab-cdef-1234567890ab": "*|FNAME|*" } }'

Updates a personalization_tag.

Authorizations

Section titled “Authorizations”
  • OAuth2
    personalization_tags:write

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspace_id
required
integer

Workspace ID

id
required
integer

Personalization Tag ID

Request Body

Section titled “Request Body”
Media typeapplication/json
object
label
string
Example
First name
default_value
string
Example
{{firstName}}
example_value
string
Example
John
dynamic_content_profile_values

A map of DynamicContentProfile IDs to platform-specific syntax values. Each value overrides the default syntax for that profile’s platform.

object
key
additional properties
string
Example
{
  "a1b2c3d4-5678-90ab-cdef-1234567890ab": "*|FNAME|*"
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful

Media typeapplication/json
object
id
required
integer
label
required
string
default_value
required
string
example_value
required
string
created_at
required
string format: date-time
updated_at
required
string format: date-time
organization_id
required
integer
dynamic_content_profile_values
required

A map of DynamicContentProfile IDs to platform-specific syntax values. Each value overrides the default syntax for that profile’s platform.

object
key
additional properties
string
Example
{
  "id": 12345,
  "label": "First name",
  "default_value": "{{firstName}}",
  "example_value": "John",
  "created_at": "2023-08-23T10:30:00.000Z",
  "updated_at": "2023-08-23T10:30:00.000Z",
  "organization_id": 12345,
  "dynamic_content_profile_values": {
    "a1b2c3d4-5678-90ab-cdef-1234567890ab": "*|FNAME|*"
  }
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}

404

Section titled “404”

Not Found

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}

422

Section titled “422”

Unprocessable Entity

Media typeapplication/json
object
message
required
string
errors
required
object
key
additional properties
Array<string>
Example
{
  "errors": {
    "username": [
      "Username is required.",
      "Username must be unique."
    ],
    "email": [
      "Invalid email format."
    ]
  }
}