Dev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideNuGetDev CommunityOptimizely AcademySubmit a ticketLog In
API Reference

Get information about coupon codes

Get detailed information about all unassigned coupon codes. You can limit the maximum number of retrieved coupon codes and sort the result by specific criteria. To get information about all assigned and/or used coupon codes, filter by recipient ID or mailing ID.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

Client ID

int64
required

Coupon block ID

Query Params
int32

Starting point of the result list

Default value : 0

int32

Maximum number of retrieved coupon codes

Default value : 100

string
enum

The status of the coupon codes to be filtered. Possible values are: assigned, unassigned, all

Allowed:
int64

Mailing IDs to which the coupon codes are assigned

string

Recipient IDs to which the coupon codes are assigned

string
enum

Sort result by specific criteria

Allowed:
string
enum

Sort order

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400

The "codeAssignment" parameter is provided simultaneously with the "mailingId" or the "recipientId", or the limit parameter is invalid. Change the limit to less than 10000.

404

The coupon block could not be found. Ensure that the required parameters such as "couponBlockId" are correct and the coupon block exists.

409

The coupon block is not assigned to the indicated client. Ensure that "clientId" and "couponBlockId" are correct and that the "couponBlockId" is assigned to the indicated client.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/vnd.optivo.broadmail.v1+json