Create a customer password reset
How to create a customer password reset via API
To create a new customer password reset, send a POST request to the /api/customer_password_resets endpoint, passing the resource arguments in the request body.
Request
POST https://yourdomain.commercelayer.io/api/customer_password_resets
Arguments
Body Parameter
Type
Required
type
string
Required
attributes.customer_email
string
Required
attributes.reference
string
Optional
attributes.reference_origin
string
Optional
attributes.metadata
object
Optional
Example
The following request creates a new customer password reset:
curl -g -X POST \
'https://yourdomain.commercelayer.io/api/customer_password_resets' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token' \
-H 'Content-Type: application/vnd.api+json' \
-d '{
"data": {
"type": "customer_password_resets",
"attributes": {
"customer_email": "[email protected]"
}
}
}'On success, the API responds with a 201 Created status code, returning the created resource object:
{
"data": {
"id": "XAyRWNUzyN",
"type": "customer_password_resets",
"links": {
"self": "https://yourdomain.commercelayer.io/api/customer_password_resets/XAyRWNUzyN"
},
"attributes": {
"customer_email": "[email protected]",
"reset_password_token": "xhFfkmfybsLxzaAP6xcs",
"reset_password_at": "2018-01-01T12:00:00.000Z",
"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/customer_password_resets/XAyRWNUzyN/relationships/customer",
"related": "https://yourdomain.commercelayer.io/api/customer_password_resets/XAyRWNUzyN/customer"
}
},
"events": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/customer_password_resets/XAyRWNUzyN/relationships/events",
"related": "https://yourdomain.commercelayer.io/api/customer_password_resets/XAyRWNUzyN/events"
}
},
"event_stores": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/customer_password_resets/XAyRWNUzyN/relationships/event_stores",
"related": "https://yourdomain.commercelayer.io/api/customer_password_resets/XAyRWNUzyN/event_stores"
}
}
},
"meta": {
"mode": "test",
"organization_id": "xRRkjDFafe",
"trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
}
}
}Last updated