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
Request
Response
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": "xYZkjABcde",
    "type": "customer_password_resets",
    "links": {
      "self": "https://yourdomain.commercelayer.io/api/customer_password_resets/xYZkjABcde"
    },
    "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/xYZkjABcde/relationships/customer",
          "related": "https://yourdomain.commercelayer.io/api/customer_password_resets/xYZkjABcde/customer"
        }
      },
      "events": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/customer_password_resets/xYZkjABcde/relationships/events",
          "related": "https://yourdomain.commercelayer.io/api/customer_password_resets/xYZkjABcde/events"
        }
      }
    },
    "meta": {
      "mode": "test"
    }
  }
}

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

The customer password reset object

List all customer password resets

Last modified 1yr ago