Coupon Codes
Coupon Codes are a feature that allow you to track performance using codes unique to each partner. They are documented in detail on the Everflow Helpdesk/.
Find All
/v1/networks/couponcodes
Filters
This endpoint supports the following API filters. Refer to our User Guide for usage.
| Value | Description |
|---|---|
| time_created | Filter based on the creation time |
| time_saved | Filter based on the last update time |
| coupon_status | Filter based on the coupon status |
| coupon_code | Filter based on the coupon name |
| network_offer_id | Filter based on the offer id |
| network_affiliate_id | Filter based on the affiliate id |
Relationships
This endpoint supports the following additional relationships. Refer to our User Guide for usage.
| Value | Description |
|---|---|
| offer | Includes the offer information |
| affiliate | Includes the affiliate information |
Request Example
cURL
curl --request GET 'https://api.eflow.team/v1/networks/couponcodes' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'
Response
{
"coupon_codes": [
{
"network_coupon_code_id": 1,
"network_id": 1,
"network_affiliate_id": 14,
"network_offer_id": 4,
"coupon_code": "SUMMER15",
"coupon_status": "active",
"internal_notes": "This coupon is only available to new customers",
"description": "15% off for all store during the summer",
"is_description_plain_text": true,
"start_date": "2025-06-01",
"end_date": "2025-09-30",
"time_created": 1709132517,
"time_saved": 1709132517
}
]
}
Find By ID
/v1/networks/couponcodes/:couponCodeId
Path Parameters
| Parameter | Description |
|---|---|
| couponCodeId | The ID of the coupon code you want to fetch |
Request Example
cURL
curl --request GET 'https://api.eflow.team/v1/networks/couponcodes/1' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'
Response
{
"network_coupon_code_id": 1,
"network_id": 1,
"network_affiliate_id": 7,
"network_offer_id": 6,
"coupon_code": "SUMMER15",
"coupon_status": "active",
"internal_notes": "This coupon is only available to new customers",
"description": "15% off for all store during the summer",
"is_description_plain_text": true,
"start_date": "2025-06-01",
"end_date": "2025-09-30",
"time_created": 1709132517,
"time_saved": 1709132517
}
Create
/v1/networks/couponcodes
Body Params
ID of the offer for which the coupon applies.
ID of the Affiliate for which the coupon applies. A coupon code without an affiliate specified can exist but cannot be used.
Coupon code value
Status of the coupon code. Can be one of the following values: active or paused.
Notes for internal usage – they will not be visible to the partner.
A description (either plain text or HTML) that will be visible to the partner
Only relevant when a description is provided. Determines if the description is in HTML or plain text format
An optional date starting at which the coupon code can be used. Use the YYYY-mm-DD format
An optional date at which the coupon code becomes obsolete. Use the YYYY-mm-DD format
Payload Example
{
"network_affiliate_id": 21,
"network_offer_id": 91,
"coupon_status": "active",
"coupon_code": "SUMMER20",
"start_date": "2025-06-01",
"end_date": "2025-09-01",
"description": "20% off all store purchases during the summer",
"is_description_plain_text": true,
"internal_notes": "Only available to new customers"
}
Update
/v1/networks/couponcodes/:couponCodeId
You must specify all the fields, not only the ones you wish to update.
If you omit a field that is not marked as required, its default value will be used.
Path Parameters
| Parameter | Description |
|---|---|
| couponCodeId | The ID of the coupon code you want to update |
Body Params
ID of the offer for which the coupon applies.
ID of the Affiliate for which the coupon applies. A coupon code without an affiliate specified can exist but cannot be used.
Coupon code value
Status of the coupon code. Can be one of the following values: active or paused.
Notes for internal usage – they will not be visible to the partner.
A description (either plain text or HTML) that will be visible to the partner
Only relevant when a description is provided. Determines if the description is in HTML or plain text format
An optional date starting at which the coupon code can be used. Use the YYYY-mm-DD format
An optional date at which the coupon code becomes obsolete. Use the YYYY-mm-DD format
Payload Example
{
"network_coupon_code_id": 1,
"network_id": 1,
"network_affiliate_id": 14,
"network_offer_id": 4,
"coupon_code": "Summer20",
"coupon_status": "paused",
"internal_notes": "This coupon is only available to new customers",
"start_date": "2020-06-01",
"end_date": "2020-09-30"
}
Delete
/v1/networks/couponcodes/:couponCodeId
Path Parameters
| Parameter | Description |
|---|---|
| couponCodeId | The ID of the coupon code you want to delete |
Request Example
cURL
curl --request DELETE 'https://api.eflow.team/v1/networks/couponcodes/1' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'
Response
{
"result": true
}