NewsMAN API: coupons.getCouponCodes

Sections

KB Newsman

HomeAPICouponscoupons.getCouponCodes

Newsman Api Method: coupons.getCouponCodes

Prototype: coupons.getCouponCodes(list_id, coupon_id, filter, start, limit)

Description: Returns an Array containing the codes of the coupon. Each array item is a hash with keys: code, created_at, expires_at, sent, subscriber_id, email, newsletter_id, form_id

HTTP method: GET

Endpoint HTTP: /coupons.getCouponCodes.json

Endpoint XML-RPC: coupons.getCouponCodes

Return type: struct

Return info: Array containing the codes of the coupon. Each array item is a hash with keys: code, created_at, expires_at, sent, subscriber_id, email, newsletter_id, form_id

Request parameters GET

Variable	Type	Description
list_id	string\|int	The ID of the list to which the coupon belongs
coupon_id	string	The ID of the coupon for which to return the codes
filter	struct\|array\|boolean	Key / value array through which the codes can be filtered. The available keys are: code, status (any, available, sent, expired), sent_to (string email). You may set this parameter to false or an empty array if you do not wish to filter codes
start	string\|int	The page number to start. Defaults to first page (start = 1).
limit	string\|int	The number of results to return per page. Defaults to 100. Upper limit is 20000.

Response parameters

Parameter	Description
code	The code
created_at	The date at which the code as added
expires_at	The date at which the code expires
sent	If the code has been sent or not
subscriber_id	The id of the subscriber to which the code was sent (if sent)
email	The email to which the code was sent (if sent)
newsletter_id	The id of the newsletter through which the code was sent (if sent)
form_id	The id of the form through which the code was sent (if sent)

Output example

[
    {
        "code": "THECODE1",
        "created_at": 1715336780,
        "expires_at": null,
        "sent": false,
        "subscriber_id": null,
        "email": null,
        "newsletter_id": null,
        "form_id": null
    },
    {
        "code": "THECODE2",
        "created_at": 1715336780,
        "expires_at": null,
        "sent": false,
        "subscriber_id": null,
        "email": null,
        "newsletter_id": null,
        "form_id": null
    },
    {
        "code": "THECODE3",
        "created_at": 1715336780,
        "expires_at": null,
        "sent": false,
        "subscriber_id": null,
        "email": null,
        "newsletter_id": null,
        "form_id": null
    },
    {
        "code": "THECODE4",
        "created_at": 1715336780,
        "expires_at": null,
        "sent": false,
        "subscriber_id": null,
        "email": null,
        "newsletter_id": null,
        "form_id": null
    },
    {
        "code": "THECODE5",
        "created_at": 1715336780,
        "expires_at": null,
        "sent": false,
        "subscriber_id": null,
        "email": null,
        "newsletter_id": null,
        "form_id": null
    },
    {
        "code": "THECODE6",
        "created_at": 1715336780,
        "expires_at": null,
        "sent": false,
        "subscriber_id": null,
        "email": null,
        "newsletter_id": null,
        "form_id": null
    },
    {
        "code": "THECODE7",
        "created_at": 1715336780,
        "expires_at": null,
        "sent": false,
        "subscriber_id": null,
        "email": null,
        "newsletter_id": null,
        "form_id": null
    },
    {
        "code": "THECODE8",
        "created_at": 1715336780,
        "expires_at": null,
        "sent": false,
        "subscriber_id": null,
        "email": null,
        "newsletter_id": null,
        "form_id": null
    },
    {
        "code": "THECODE9",
        "created_at": 1715336780,
        "expires_at": null,
        "sent": false,
        "subscriber_id": null,
        "email": null,
        "newsletter_id": null,
        "form_id": null
    },
    {
        "code": "THECODE10",
        "created_at": 1715336780,
        "expires_at": null,
        "sent": false,
        "subscriber_id": null,
        "email": null,
        "newsletter_id": null,
        "form_id": null
    }
]

Response Errors

Code	Message	Description
407	Missing required param list_id	list_id param is required
407	Missing required param coupon_id	coupon_id param is required
407	Missing required param filter	filter param is required
407	Missing required param start	start param is required
407	Missing required param limit	limit param is required
101	Not allowed for list_id = %s	Invalid access to list_id
101	No such coupon with ID: %s	No such coupon with ID: %s

Error examples

{
    "err": true,
    "message": "Missing required param list_id",
    "code": 407
}

{
    "err": true,
    "message": "Missing required param coupon_id",
    "code": 407
}

{
    "err": true,
    "message": "Missing required param filter",
    "code": 407
}

{
    "err": true,
    "message": "Missing required param start",
    "code": 407
}

{
    "err": true,
    "message": "Missing required param limit",
    "code": 407
}