Comment on page
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.POST https://yourdomain.commercelayer.io/api/coupon_recipients
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 |
Request
Response
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]"
}
}
}'
On success, the API responds with a
201 Created status code, returning the created resource object:{
"data": {
"id": "xYZkjABcde",
"type": "coupon_recipients",
"links": {
"self": "https://yourdomain.commercelayer.io/api/coupon_recipients/xYZkjABcde"
},
"attributes": {
"email": "[email protected]",
"first_name": "John",
"last_name": "Smith",
"created_at": "2018-01-01T12:00:00.000Z",
"updated_at": "2018-01-01T12:00:00.000Z",
"reference": "ANY-EXTERNAL-REFEFERNCE",
"reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
"metadata": {
"foo": "bar"
}
},
"relationships": {
"customer": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/coupon_recipients/xYZkjABcde/relationships/customer",
"related": "https://yourdomain.commercelayer.io/api/coupon_recipients/xYZkjABcde/customer"
}
},
"attachments": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/coupon_recipients/xYZkjABcde/relationships/attachments",
"related": "https://yourdomain.commercelayer.io/api/coupon_recipients/xYZkjABcde/attachments"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/coupon_recipients/xYZkjABcde/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/coupon_recipients/xYZkjABcde/versions"
}
}
},
"meta": {
"mode": "test"
}
}
}
Last modified 3mo ago