Skip to content
Documentation

Create Link Tracking Profile

POST
/api/v1/workspaces/{workspace_id}/link_tracking_profiles
curl --request POST \
  --url https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/link_tracking_profiles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "My Link Tracking Profile", "parameters": [ { "type": "fixed_value", "parameter": "utm_source", "value": "newsletter", "label": "example", "hint": "example" } ], "custom_template": "{{ url }}" }'

Creates a new Link Tracking Profile.

Authorizations

Section titled “Authorizations”
  • OAuth2
    link_tracking_profiles:write

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspace_id
required
integer

Workspace ID

Request Body

Section titled “Request Body”
Media typeapplication/json
object
name
required
string
Example
My Link Tracking Profile
parameters
required
Array
One of:
object
type
required
string
Allowed values: fixed_value
parameter
required

The URL query parameter name.

string
Example
utm_source
value
required

The fixed value for this parameter.

string
Example
newsletter
label
string | null
hint
string | null
custom_template
required
string | null
Example
{{ url }}

Responses

Section titled “Responses”

200

Section titled “200”

Successful

Media typeapplication/json
object
id
required
integer
name
required
string
parameters
Array
One of:
object
type
required
string
Allowed values: fixed_value
parameter
required

The URL query parameter name.

string
value
required

The fixed value for this parameter.

string
label
string | null
hint
string | null
custom_template
string | null
created_at
required
string format: date-time
updated_at
required
string format: date-time
Example
{
  "id": 12345,
  "name": "My Link Tracking Profile",
  "parameters": [
    {
      "type": "fixed_value",
      "parameter": "utm_source",
      "value": "newsletter"
    }
  ],
  "custom_template": "{{ url }}",
  "created_at": "2023-08-23T10:30:00.000Z",
  "updated_at": "2023-08-23T10:30:00.000Z"
}

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"
}

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."
    ]
  }
}