Skip to content
Documentation

Update Link Tracking Profile

PATCH
/api/v1/workspaces/{workspace_id}/link_tracking_profiles/{id}

Updates a link_tracking_profile.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspace_id
required
integer

Workspace ID

id
required
integer

Link Tracking Profile ID

Request Body

Section titled “Request Body ”
object
name
string
Example
My Link Tracking Profile
parameters
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
nullable
hint
string
nullable
custom_template
string
nullable
Example
{{ url }}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful

object
id
required
integer
Example
12345
name
required
string
Example
My Link Tracking Profile
parameters
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
nullable
hint
string
nullable
custom_template
string
nullable
Example
{{ url }}
created_at
required
string format: date-time
Example
2023-08-23T10:30:00.000Z
updated_at
required
string format: date-time
Example
2023-08-23T10:30:00.000Z

401

Section titled “401 ”

Unauthorized

object
message
required
string
Example
Record not found

403

Section titled “403 ”

Forbidden

object
message
required
string
Example
Record not found

404

Section titled “404 ”

Not Found

object
message
required
string
Example
Record not found

422

Section titled “422 ”

Unprocessable Entity

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