v1

latestOpenAPI 3.0.32026-07-2226694862.5 KB

Coupon Codes

Update Coupon Code

Update an existing coupon code. Any omitted non-required fields will be reset to defaults.

put/networks/couponcodes/{couponCodeId}

Path parameters

couponCodeIdinteger required

The ID of the coupon code you want to update.

Request body

network_offer_idinteger required

ID of the offer for which the coupon applies.

network_affiliate_idinteger

ID of the affiliate for which the coupon applies. A coupon code without an affiliate specified can exist but cannot be used.

coupon_codestring required

Coupon code value.

coupon_status'active' | 'paused' required

Status of the coupon code. Can be one of the following values: active or paused.

internal_notesstring

Notes for internal usage -- they will not be visible to the partner.

descriptionstring

A description (either plain text or HTML) that will be visible to the partner.

is_description_plain_textboolean

Only relevant when a description is provided. Determines if the description is in HTML or plain text format.

start_datestring

An optional date starting at which the coupon code can be used. Use the YYYY-MM-DD format.

end_datestring

An optional date at which the coupon code becomes obsolete. Use the YYYY-MM-DD format.

Response

network_coupon_code_idinteger

Unique identifier for this coupon code.

network_idinteger

The ID of the network this coupon code belongs to.

network_affiliate_idinteger

ID of the affiliate for which the coupon applies. A coupon code without an affiliate specified can exist but cannot be used.

network_offer_idinteger

ID of the offer for which the coupon applies.

coupon_codestring

Coupon code value.

coupon_status'active' | 'paused'

Status of the coupon code. Can be one of the following values: active or paused.

internal_notesstring

Notes for internal usage -- they will not be visible to the partner.

descriptionstring

A description (either plain text or HTML) that will be visible to the partner.

is_description_plain_textboolean

Only relevant when a description is provided. Determines if the description is in HTML or plain text format.

start_datestring

An optional date starting at which the coupon code can be used. Uses the YYYY-MM-DD format.

end_datestring

An optional date at which the coupon code becomes obsolete. Uses the YYYY-MM-DD format.

time_createdinteger

Unix timestamp of when the coupon code was created.

time_savedinteger

Unix timestamp of when the coupon code was last updated.

time_deletedinteger

Unix timestamp of when the coupon code was deleted. 0 if not deleted.

Example response

{
  "time_created": 1734455015,
  "time_saved": 1734455015
}