Create a coupon recipient

How to create a coupon recipient via API

To create a new coupon recipient, send a POST request to the /api/coupon_recipients endpoint, passing the resource arguments in the request body.

Request

POST https://yourdomain.commercelayer.io/api/coupon_recipients

Arguments

Body Parameter	Type	Required
type	string	Required
attributes.email	string	Required
attributes.first_name	string	Optional
attributes.last_name	string	Optional
attributes.reference	string	Optional
attributes.reference_origin	string	Optional
attributes.metadata	object	Optional
relationships.customer	object	Optional

Example

Request

The following request creates a new coupon recipient:

curl -g -X POST \
  'https://yourdomain.commercelayer.io/api/coupon_recipients' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "coupon_recipients",
    "attributes": {
      "email": "[email protected]"
    }
  }
}'

Response