advertiser/creative/coupon
This resource allows you to create, retrieve, update, and delete coupon creatives.
| GET | ||||
|---|---|---|---|---|
| Request Parameters | ||||
| Parameter | Description | Possible Values | Default | Required? |
| id | The id, or comma-separated list of ids, of the creative(s) you want to retrieve. If one id is provided, the resource object will be returned. If a comma-separated list of ids are provided, a list of objects will be returned. | * 987 OR 123,456,789 | N/A | No |
| promotion | The promotion id, or comma-separated list of promotion ids, to filter by | * 987 OR 123,456,789 | N/A | No |
| status | The status, or comma-separated list of statuses, to filter by | active, inactive, scheduled, date_range | N/A | No |
| Response Fields | ||||
| Field | Description | Notes | ||
| id | Creative id | |||
| type | Creative type | |||
| name | The name of the creative | Used for internal display to publishers | ||
| description | A description of the banner creative | |||
| coupon_code | The code used to redeem the coupon. | Exclusive coupon codes ending in an asterisk will treat the asterisk as a wildcard for attribution purposes. | ||
| url | The destination url for the coupon. | |||
| personalized | A boolean flag that indicates whether a coupon is exclusive for 1 affiliate. | Exclusive coupons must be unique among your programs creatives. They, also, have stricter requirements for the coupon code. Coupon codes must be alphanumeric and 25 or less characters. Coupons must be set to private with only 1 publisher selected. | ||
| promotions | An array of promotions applied to a creative | |||
| promotions[n][id] | The promotion id | |||
| promotions[n][name] | The name of the promotion | |||
| private | Indicates whether the creative is private among a group of affiliates | 1 OR 0 | ||
| private_affiliates | An array of of affiliates the private creative is limited to | If this node is not present, the private creative is shown to no affiliates. | ||
| private_affiliates[n][affiliate_id] | The affiliate id of the private affiliate | |||
| private_affiliates[n][first_name] | The first name of the private affiliate | |||
| private_affiliates[n][last_name] | The last name of the private affiliate | |||
| start_date | Start date for the creative | YYYY-MM-DD HH:00:00 | ||
| end_date | End date for the creative | YYYY-MM-DD HH:00:00 | ||
| view_date | View date for the creative | YYYY-MM-DD HH:00:00 | ||
| created | Date the creative was created | |||
| modified | Date the creative was modified | |||
| status | Status of the creative | |||
| POST | ||||
|---|---|---|---|---|
| Request Parameters | ||||
| Parameter | Description | Possible Values | Default | Required? |
| N/A | ||||
| Post Parameters | ||||
| Parameter | Description | Possible Values | Default | Required? |
| name | The name of the creative | * Any generic string | N/A | Yes |
| description | A description of the creative | * Any generic string | N/A | Yes |
| url | The destination url for the coupon. | * Any valid url | N/A | Yes |
| coupon_code | The code used to redeem the coupon. Exclusive coupon codes ending in an asterisk will treat the asterisk as a wildcard for attribution purposes. | * Any generic string | N/A | Yes |
| personalized | A boolean flag that indicates whether a coupon is exclusive for 1 affiliate. Exclusive coupons must be unique among your programs creatives. They, also, have stricter requirements for the coupon code. Coupon codes must be alphanumeric and 25 or less characters. Coupons must be set to private with only 1 publisher selected. | 1 OR 0 | N/A | No |
| status | The status of the creative | active, inactive OR date_range | N/A | Yes |
| promotions | Promotion id(s) being assigned to the creative | * 987 OR 123,456,789 | N/A | Yes |
| private | A flag indicating whether this creative is private. Required for personalized coupons. | 1 OR 0 | N/A | Dependent |
| private_affiliates | A comma-separated list of affiliate ids used to limit the creative's visibility. Required for personalized coupons. | * 987 OR 123,456,789 | N/A | Dependent |
| start_date | Start date for the creative | * YYYY-MM-DD HH:00:00 | N/A | No |
| end_date | End date for the creative | * YYYY-MM-DD HH:00:00 | N/A | No |
| view_date | View date for the creative | * YYYY-MM-DD HH:00:00 | N/A | No |
| Response Fields | ||||
| Field | Description | Notes | ||
| N/A | ||||
| PUT | ||||
|---|---|---|---|---|
| Request Parameters | ||||
| Parameter | Description | Possible Values | Default | Required? |
| id | The id of the creative being updated | * 123 | N/A | Yes |
| Put Parameters | ||||
| Parameter | Description | Possible Values | Default | Required? |
| name | The name of the creative | * Any generic string | N/A | No |
| description | A description of the creative | * Any generic string | N/A | No |
| url | The destination url for the coupon. | * Any valid url | N/A | No |
| coupon_code | The code used to redeem the coupon. Exclusive coupon codes ending in an asterisk will treat the asterisk as a wildcard for attribution purposes. | * Any generic string | N/A | No |
| personalized | A boolean flag that indicates whether a coupon is exclusive for 1 affiliate. Exclusive coupons must be unique among your programs creatives. They, also, have stricter requirements for the coupon code. Coupon codes must be alphanumeric and 25 or less characters. Coupons must be set to private with only 1 publisher selected. | 1 OR 0 | N/A | No |
| status | The status of the creative | active, inactive OR date_range | N/A | Yes |
| promotions | Promotion id(s) being assigned to the creative | * 987 OR 123,456,789 | N/A | Yes |
| private | A flag indicating whether this creative is private. Required for personalized coupons. | 1 OR 0 | N/A | Dependent |
| private_affiliates | A comma-separated list of affiliate ids used to limit the creative's visibility. Required for personalized coupons. | * 987 OR 123,456,789 | N/A | Dependent |
| start_date | Start date for the creative | * YYYY-MM-DD HH:00:00 | N/A | No |
| end_date | End date for the creative | * YYYY-MM-DD HH:00:00 | N/A | No |
| view_date | View date for the creative | * YYYY-MM-DD HH:00:00 | N/A | No |
| Response Fields | ||||
| Field | Description | Notes | ||
| N/A | ||||
| DELETE | ||||
|---|---|---|---|---|
| Request Parameters | ||||
| Parameter | Description | Possible Values | Default | Required? |
| id | The id of the creative being deleted | * 123 | N/A | Yes |
| Response Fields | ||||
| Field | Description | Notes | ||
| N/A | ||||
* Values shown are placeholder values. Please replace with actual data.