Skip to main content
POST
Create a promotion URL. The audience determines which assignment field is required:
  • all_affiliates: omit both group_ids and product_ids.
  • groups: provide one or more group_ids and omit product_ids.
  • products: provide one or more product_ids and omit group_ids.
All referenced groups must belong to the program and products must belong to your team. Duplicate assignment IDs are accepted and stored once.

Body Parameters

string
required
Display name, 1–255 characters.
string
required
HTTP(S) destination URL, up to 2048 characters.
string
required
One of all_affiliates, groups, or products.
string | null
Optional description.
array
Required for groups; not allowed for other audiences.
array
Required for products; not allowed for other audiences.
boolean
Whether the URL is available. Defaults to true.
integer
Non-negative selection priority. Defaults to 0.

Response

Returns the created promotion URL. See List Promotion URLs for the response object.