RErebrandly
Workspaces

Update Workspace Conversion Tracking Settings

Enable or disable conversion tracking and configure the attribution window for a workspace.

Requires Feature: extra.conversion_tracking

Behavior:

  • When enabled=true: Activates conversion tracking. If attributionWindow is not provided, defaults to 30 days.
  • When enabled=false: Disables conversion tracking. The attributionWindow is preserved (from body if provided, otherwise from the previous DB value, otherwise null).
post/workspaces/{workspace_id}/conversion-tracking

Request

  • Base URL
    https://api.rebrandly.com/v1
  • URL
    https://api.rebrandly.com/v1/workspaces/{workspace_id}/conversion-tracking
  • Auth
    API key in header apikey

Path parameters

workspace_idstring required

The public ID of the workspace

Headers

apikeystring required

API key for authentication

Request body

enabledboolean required

Whether conversion tracking is enabled for this workspace

attributionWindowinteger

Attribution window in days. Defaults to 30 when enabling without specifying a value. When disabling, the previous value is preserved (from DB if not provided in body).

Response

Updated conversion tracking settings

enabledboolean required

Whether conversion tracking is enabled for this workspace

attributionWindowinteger nullable

Attribution window in days. null when conversion tracking is not configured or disabled. Defaults to 30 when enabled without specifying a value.

apiKeyCreatedByOwnerboolean nullable

Whether the workspace Owner has created a conversion tracking API key. API keys are account-level resources always created by the account they belong to, so existence implies the Owner created it. The key value itself is never exposed.

On the dedicated /workspaces/{workspace_id}/conversion-tracking endpoint this is always a boolean (the endpoint is restricted to owner/admin). On the workspaces list (include=conversionTracking) it is a boolean for workspaces where the caller has the owner or admin role, and null for lower roles (the field is always present).

Example response

{
  "enabled": true,
  "attributionWindow": 30,
  "apiKeyCreatedByOwner": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.