Skip to main content

Create campaign tracking link

POST 
/v1/partnership/campaigns/:campaign_code/links

Create an additional tracking link for an existing campaign. The response contains the generated URL, link code, platform, operating-system, and tag attributes used for campaign attribution.

Required scopes:

  • write: partnership.all.

Runtime restrictions:

  • campaign_code must identify a campaign belonging to the partner associated with the API key. Otherwise, the operation returns NotFound.

Rules:

  • platform, when supplied, must be mobile; os, when supplied, must be ios or android.
  • You can provide up to five tags. Each tag must contain one to 16 ASCII letters or digits.
  • partner_code, when supplied, can contain up to 10 characters.

Rate limits:

  • This operation counts toward the shared limit of 600 requests per 60 seconds per partner, across all of the partner's API keys and all Partnership API operations.

Consistency and recovery notes:

  • The current Partnership API does not provide idempotent-write semantics. After a timeout or connection failure, read the affected resource or list before deciding whether to retry.

Possible errors:

  • Throttled
  • ServiceTransportError
  • Error
  • AuthenticationFailed
  • PermissionDenied
  • ValidationError
  • NotFound
  • NotUnique
  • ManyItems

Request​

Responses​

Successful response.