Brevo

Brevo Coupons API

The coupons API from Brevo — 3 operation(s) for coupons.

GitHub OpenAPI
Business capability
Discount & Promotion Management BC-440.30

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /couponCollections List coupon collections · Get all your coupon collections #
Ask an LLM
“What coupon collections do I have and how many coupons remain?”
“Can I sort coupon collections by expiration date?”
Tell an agent
List my coupon collections.
Show coupon collections sorted by {sortBy}.
POST /couponCollections Create a coupon collection · Create а coupon collection #
Ask an LLM
“How do I set up a new pool of discount coupons?”
“Can I get alerted when a coupon collection runs low?”
Tell an agent
Create coupon collection {name} with default coupon {defaultCoupon}.
Create collection {name}, default {defaultCoupon}, expiring {expirationDate}.
GET /couponCollections/{id} Get a coupon collection · Get a coupon collection by id #
Ask an LLM
“How many coupons are left in one collection?”
“What is the default coupon value of a specific collection?”
Tell an agent
Show coupon collection {id}.
Get remaining coupon count for collection {id}.
PATCH /couponCollections/{id} Update a coupon collection · Update a coupon collection by id #
Ask an LLM
“Can I change the expiration date of a coupon collection?”
“Is it possible to remove the low-stock alert on a collection?”
Tell an agent
Set collection {id} to expire on {expirationDate}.
Change the default coupon of collection {id} to {defaultCoupon}.
POST /coupons Add coupon codes to a collection · Create coupons for a coupon collection #
Ask an LLM
“How do I upload coupon codes into a collection?”
“What's the maximum number of coupon codes per upload?”
Tell an agent
Add coupons {coupons} to collection {collectionId}.
Upload these codes {coupons} into coupon collection {collectionId}.

Documentation

📖
Documentation
https://developers.brevo.com/docs/loyalty-overview
📖
APIReference
https://developers.brevo.com/reference
📖
Documentation
https://developers.brevo.com/reference
📖
Documentation
https://developers.brevo.com/docs/getting-started-with-senders-and-domains
📖
Documentation
https://developers.brevo.com/docs/event-endpoints
📖
Documentation
https://developers.brevo.com/docs/custom-objects-management
📖
Documentation
https://developers.brevo.com/reference/get-wallet-pass-install-url

Specifications

⚙
OpenAPI
https://artifacts.apis.io/brevo/openapi/brevo-coupons-api-openapi.yml
⚙
AsyncAPI
https://artifacts.apis.io/brevo/asyncapi/brevo-webhooks-asyncapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/brevo/json-schema/brevo-get-coupon-collection-schema.json
📊
JSONSchema
https://artifacts.apis.io/brevo/json-schema/brevo-coupons-update-coupon-collection-response-200-schema.json
📊
JSONSchema
https://artifacts.apis.io/brevo/json-schema/brevo-coupons-create-coupon-collection-response-201-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/brevo:brevo-coupons-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

brevo-coupons-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Ecommerce Coupons API
  version: 1.0.0
servers:
- url: https://api.brevo.com/v3
  description: https://api.brevo.com/v3
tags:
- name: Coupons
paths:
  /couponCollections:
    get:
      operationId: getCouponCollections
      summary: Get all your coupon collections
      description: Retrieve a paginated list of all coupon collections in your Brevo account. Results can be sorted by creation date, remaining coupons count, or expiration date, in ascending or descending order. Pagination defaults to 50 collections per page (maximum 100).
      tags:
      - Coupons
      parameters:
      - name: limit
        in: query
        description: Number of documents returned per page
        required: false
        schema:
          type: integer
          format: int64
          default: 50
      - name: offset
        in: query
        description: Index of the first document on the page
        required: false
        schema:
          type: integer
          format: int64
          default: 0
      - name: sort
        in: query
        description: Sort the results by creation time in ascending/descending order
        required: false
        schema:
          $ref: '#/components/schemas/CouponCollectionsGetParametersSort'
          default: desc
      - name: sortBy
        in: query
        description: The field used to sort coupon collections
        required: false
        schema:
          $ref: '#/components/schemas/CouponCollectionsGetParametersSortBy'
          default: createdAt
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Coupon collections
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getCouponCollection'
        '400':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCouponCollectionsRequestBadRequestError'
        '401':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCouponCollectionsRequestUnauthorizedError'
    post:
      operationId: createCouponCollection
      summary: Create а coupon collection
      description: Create a new coupon collection with a name and a default coupon value. You can optionally set an expiration date in RFC3339 format and configure alert thresholds to receive email notifications when remaining coupons or remaining days before expiration fall below a specified number. The collection ID is auto-generated as a UUID and returned in the response.
      tags:
      - Coupons
      parameters:
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Coupon collection created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Coupons_createCouponCollection_Response_201'
        '400':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCouponCollectionRequestBadRequestError'
        '401':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCouponCollectionRequestUnauthorizedError'
      requestBody:
        description: Values to create a coupon collection
        content:
          application/json:
            schema:
              type: object
              properties:
                defaultCoupon:
                  type: string
                  description: Default coupons collection name
                expirationDate:
                  type: string
                  format: date-time
                  description: Specify an expiration date for the coupon collection in RFC3339 format. Use null to remove the expiration date.
                name:
                  type: string
                  description: Name of the coupons collection
                remainingCouponsAlert:
                  type: integer
                  description: Send a notification alert (email) when the remaining coupons count is equal or fall bellow this number. Use null to disable alerts.
                remainingDaysAlert:
                  type: integer
                  description: Send a notification alert (email) when the remaining days until the expiration date are equal or fall bellow this number. Use null to disable alerts.
              required:
              - defaultCoupon
              - name
  /couponCollections/{id}:
    get:
      operationId: getCouponCollection
      summary: Get a coupon collection by id
      description: Retrieve the details of a single coupon collection by its UUID. The response includes the collection name, default coupon value, total and remaining coupon counts, and creation timestamp. Returns a `404` error if no collection matches the provided ID.
      tags:
      - Coupons
      parameters:
      - name: id
        in: path
        description: Id of the collection to return
        required: true
        schema:
          type: string
          format: uuidv4
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Coupon collection
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getCouponCollection'
        '400':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCouponCollectionRequestBadRequestError'
        '401':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCouponCollectionRequestUnauthorizedError'
        '404':
          description: Coupon collection not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
    patch:
      operationId: updateCouponCollection
      summary: Update a coupon collection by id
      description: Update an existing coupon collection by its UUID. You can modify the default coupon value, set or remove the expiration date (pass `null` to remove), and configure or disable alert thresholds for remaining coupons or remaining days. Only the fields included in the request body are updated; omitted fields remain unchanged.
      tags:
      - Coupons
      parameters:
      - name: id
        in: path
        description: Id of the collection to update
        required: true
        schema:
          type: string
          format: uuidv4
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Coupon collection updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Coupons_updateCouponCollection_Response_200'
        '400':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateCouponCollectionRequestBadRequestError'
        '401':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateCouponCollectionRequestUnauthorizedError'
      requestBody:
        description: Values to update the coupon collection
        content:
          application/json:
            schema:
              type: object
              properties:
                defaultCoupon:
                  type: string
                  description: A default coupon to be used in case there are no coupons left
                expirationDate:
                  type: string
                  format: date-time
                  description: Specify an expiration date for the coupon collection in RFC3339 format. Use null to remove the expiration date.
                remainingCouponsAlert:
                  type: integer
                  description: Send a notification alert (email) when the remaining coupons count is equal or fall bellow this number. Use null to disable alerts.
                remainingDaysAlert:
                  type: integer
                  description: Send a notification alert (email) when the remaining days until the expiration date are equal or fall bellow this number. Use null to disable alerts.
  /coupons:
    post:
      operationId: createCoupons
      summary: Create coupons for a coupon collection
      description: Add coupons to an existing coupon collection. The `coupons` array must contain between 1 and 10,000 unique coupon code strings, all associated with the specified `collectionId`. Coupon creation is processed asynchronously and a `204` status is returned immediately upon acceptance. Returns a `404` error if the specified coupon collection does not exist.
      tags:
      - Coupons
      parameters:
      - name: api-key
        in: header
        description: The API key should be passed in the request headers as `api-key` for authentication.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Coupons creation in progress
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '400':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCouponsRequestBadRequestError'
        '401':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCouponsRequestUnauthorizedError'
        '404':
          description: Coupon collection not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorModel'
      requestBody:
        description: Values to create coupons
        content:
          application/json:
            schema:
              type: object
              properties:
                collectionId:
                  type: string
                  format: uuidv4
                  description: The id of the coupon collection for which the coupons will be created
                coupons:
                  type: array
                  items:
                    type: string
              required:
              - collectionId
              - coupons
components:
  schemas:
    getCouponCollection:
      type: object
      properties:
        createdAt:
          type: string
          format: date-time
          description: Datetime on which the collection was created.
        defaultCoupon:
          type: string
          description: The default coupon of the collection.
        expirationDate:
          type: string
          format: date-time
          description: Expiration date for the coupon collection in RFC3339 format.
        id:
          type: string
          format: uuidv4
          description: The id of the collection.
        name:
          type: string
          description: The name of the collection.
        remainingCoupons:
          type: integer
          format: int64
          description: Number of coupons that have not been sent yet.
        remainingCouponsAlert:
          type: integer
          description: If present, an email notification is going to be sent when the total number of available coupons falls below the defined threshold.
        remainingDaysAlert:
          type: integer
          description: If present, an email notification is going to be sent the defined amount of days before to the expiration date.
        totalCoupons:
          type: integer
          format: int64
          description: Total number of coupons in the collection.
      required:
      - createdAt
      - defaultCoupon
      - id
      - name
      - remainingCoupons
      - totalCoupons
      title: getCouponCollection
    Coupons_createCouponCollection_Response_201:
      type: object
      properties:
        id:
          type: string
          format: uuidv4
          description: The id of the created collection
      required:
      - id
      title: Coupons_createCouponCollection_Response_201
    CouponCollectionsIdGetResponsesContentApplicationJsonSchemaCode:
      type: string
      enum:
      - invalid_parameter
      - missing_parameter
      - out_of_range
      - campaign_processing
      - campaign_sent
      - document_not_found
      - not_enough_credits
      - permission_denied
      - duplicate_parameter
      - duplicate_request
      - method_not_allowed
      - unauthorized
      - account_under_validation
      - not_acceptable
      - bad_request
      - unprocessable_entity
      - Domain does not exist
      - Contact email not found
      - Attribute not found
      - Category id not found
      - Invalid parameters passed
      - Record(s) for identifier not found
      - Returned when query params are invalid
      - Returned when invalid data posted
      - Feed not found
      - Campaign ID not found
      - api-key not found
      - DMARC policy requires domain authentication
      - DNS records not properly configured
      - Invalid OTP code provided
      - OTP code has expired
      - Domain already exists in your account
      - The sum of all IP weights must equal 100
      - Authentication failed
      - Insufficient credits
      - Request already processed
      description: Error code displayed in case of a failure
      title: CouponCollectionsIdGetResponsesContentApplicationJsonSchemaCode
    CreateCouponsRequestBadRequestError:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/CouponsPostResponsesContentApplicationJsonSchemaCode'
          description: Error code displayed in case of a failure
        message:
          type: string
          description: Readable message associated to the failure
      required:
      - code
      - message
      title: CreateCouponsRequestBadRequestError
    GetCouponCollectionRequestUnauthorizedError:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/CouponCollectionsIdGetResponsesContentApplicationJsonSchemaCode'
          description: Error code displayed in case of a failure
        message:
          type: string
          description: Readable message associated to the failure
      required:
      - code
      - message
      title: GetCouponCollectionRequestUnauthorizedError
    UpdateCouponCollectionRequestBadRequestError:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/CouponCollectionsIdPatchResponsesContentApplicationJsonSchemaCode'
          description: Error code displayed in case of a failure
        message:
          type: string
          description: Readable message associated to the failure
      required:
      - code
      - message
      title: UpdateCouponCollectionRequestBadRequestError
    CouponCollectionsPostResponsesContentApplicationJsonSchemaCode:
      type: string
      enum:
      - invalid_parameter
      - missing_parameter
      - out_of_range
      - campaign_processing
      - campaign_sent
      - document_not_found
      - not_enough_credits
      - permission_denied
      - duplicate_parameter
      - duplicate_request
      - method_not_allowed
      - unauthorized
      - account_under_validation
      - not_acceptable
      - bad_request
      - unprocessable_entity
      - Domain does not exist
      - Contact email not found
      - Attribute not found
      - Category id not found
      - Invalid parameters passed
      - Record(s) for identifier not found
      - Returned when query params are invalid
      - Returned when invalid data posted
      - Feed not found
      - Campaign ID not found
      - api-key not found
      - DMARC policy requires domain authentication
      - DNS records not properly configured
      - Invalid OTP code provided
      - OTP code has expired
      - Domain already exists in your account
      - The sum of all IP weights must equal 100
      - Authentication failed
      - Insufficient credits
      - Request already processed
      description: Error code displayed in case of a failure
      title: CouponCollectionsPostResponsesContentApplicationJsonSchemaCode
    UpdateCouponCollectionRequestUnauthorizedError:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/CouponCollectionsIdPatchResponsesContentApplicationJsonSchemaCode'
          description: Error code displayed in case of a failure
        message:
          type: string
          description: Readable message associated to the failure
      required:
      - code
      - message
      title: UpdateCouponCollectionRequestUnauthorizedError
    errorModel:
      type: object
      properties:
        code:
          type: string
          description: Error code displayed in case of a failure
        message:
          type: string
          description: Readable message associated to the failure
      required:
      - message
      title: errorModel
    CreateCouponCollectionRequestUnauthorizedError:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/CouponCollectionsPostResponsesContentApplicationJsonSchemaCode'
          description: Error code displayed in case of a failure
        message:
          type: string
          description: Readable message associated to the failure
      required:
      - code
      - message
      title: CreateCouponCollectionRequestUnauthorizedError
    CreateCouponCollectionRequestBadRequestError:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/CouponCollectionsPostResponsesContentApplicationJsonSchemaCode'
          description: Error code displayed in case of a failure
        message:
          type: string
          description: Readable message associated to the failure
      required:
      - code
      - message
      title: CreateCouponCollectionRequestBadRequestError
    GetCouponCollectionsRequestUnauthorizedError:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/CouponCollectionsGetResponsesContentApplicationJsonSchemaCode'
          description: Error code displayed in case of a failure
        message:
          type: string
          description: Readable message associated to the failure
      required:
      - code
      - message
      title: GetCouponCollectionsRequestUnauthorizedError
    CouponCollectionsIdPatchResponsesContentApplicationJsonSchemaCode:
      type: string
      enum:
      - invalid_parameter
      - missing_parameter
      - out_of_range
      - campaign_processing
      - campaign_sent
      - document_not_found
      - not_enough_credits
      - permission_denied
      - duplicate_parameter
      - duplicate_request
      - method_not_allowed
      - unauthorized
      - account_under_validation
      - not_acceptable
      - bad_request
      - unprocessable_entity
      - Domain does not exist
      - Contact email not found
      - Attribute not found
      - Category id not found
      - Invalid parameters passed
      - Record(s) for identifier not found
      - Returned when query params are invalid
      - Returned when invalid data posted
      - Feed not found
      - Campaign ID not found
      - api-key not found
      - DMARC policy requires domain authentication
      - DNS records not properly configured
      - Invalid OTP code provided
      - OTP code has expired
      - Domain already exists in your account
      - The sum of all IP weights must equal 100
      - Authentication failed
      - Insufficient credits
      - Request already processed
      description: Error code displayed in case of a failure
      title: CouponCollectionsIdPatchResponsesContentApplicationJsonSchemaCode
    CreateCouponsRequestUnauthorizedError:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/CouponsPostResponsesContentApplicationJsonSchemaCode'
          description: Error code displayed in case of a failure
        message:
          type: string
          description: Readable message associated to the failure
      required:
      - code
      - message
      title: CreateCouponsRequestUnauthorizedError
    Coupons_updateCouponCollection_Response_200:
      type: object
      properties:
        defaultCoupon:
          type: string
          description: The default coupon of the collection
        id:
          type: string
          format: uuidv4
          description: The id of the collection
        name:
          type: string
          description: The name of the collection
      required:
      - defaultCoupon
      - id
      - name
      title: Coupons_updateCouponCollection_Response_200
    CouponCollectionsGetParametersSort:
      type: string
      enum:
      - asc
      - desc
      default: desc
      title: CouponCollectionsGetParametersSort
    CouponCollectionsGetParametersSortBy:
      type: string
      enum:
      - createdAt
      - remainingCoupons
      - expirationDate
      default: createdAt
      title: CouponCollectionsGetParametersSortBy
    CouponsPostResponsesContentApplicationJsonSchemaCode:
      type: string
      enum:
      - invalid_parameter
      - missing_parameter
      - out_of_range
      - campaign_processing
      - campaign_sent
      - document_not_found
      - not_enough_credits
      - permission_denied
      - duplicate_parameter
      - duplicate_request
      - method_not_allowed
      - unauthorized
      - account_under_validation
      - not_acceptable
      - bad_request
      - unprocessable_entity
      - Domain does not exist
      - Contact email not found
      - Attribute not found
      - Category id not found
      - Invalid parameters passed
      - Record(s) for identifier not found
      - Returned when query params are invalid
      - Returned when invalid data posted
      - Feed not found
      - Campaign ID not found
      - api-key not found
      - DMARC policy requires domain authentication
      - DNS records not properly configured
      - Invalid OTP code provided
      - OTP code has expired
      - Domain already exists in your account
      - The sum of all IP weights must equal 100
      - Authentication failed
      - Insufficient credits
      - Request already processed
      description: Error code displayed in case of a failure
      title: CouponsPostResponsesContentApplicationJsonSchemaCode
    GetCouponCollectionsRequestBadRequestError:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/CouponCollectionsGetResponsesContentApplicationJsonSchemaCode'
          description: Error code displayed in case of a failure
        message:
          type: string
          description: Readable message associated to the failure
      required:
      - code
      - message
      title: GetCouponCollectionsRequestBadRequestError
    GetCouponCollectionRequestBadRequestError:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/CouponCollectionsIdGetResponsesContentApplicationJsonSchemaCode'
          description: Error code displayed in case of a failure
        message:
          type: string
          description: Readable message associated to the failure
      required:
      - code
      - message
      title: GetCouponCollectionRequestBadRequestError
    CouponCollectionsGetResponsesContentApplicationJsonSchemaCode:
      type: string
      enum:
      - invalid_parameter
      - missing_parameter
      - out_of_range
      - campaign_processing
      - campaign_sent
      - document_not_found
      - not_enough_credits
      - permission_denied
      - duplicate_parameter
      - duplicate_request
      - method_not_allowed
      - unauthorized
      - account_under_validation
      - not_acceptable
      - bad_request
      - unprocessable_entity
      - Domain does not exist
      - Contact email not found
      - Attribute not found
      - Category id not found
      - Invalid parameters passed
      - Record(s) for identifier not found
      - Returned when query params are invalid
      - Returned when invalid data posted
      - Feed not found
      - Campaign ID not found
      - api-key not found
      - DMARC policy requires domain authentication
      - DNS records not properly configured
      - Invalid OTP code provided
      - OTP code has expired
      - Domain already exists in your account
      - The sum of all IP weights must equal 100
      - Authentication failed
      - Insufficient credits
      - Request already processed
      description: Error code displayed in case of a failure
      title: CouponCollectionsGetResponsesContentApplicationJsonSchemaCode
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: api-key
      description: The API key should be passed in the request headers as `api-key` for authentication.