SEsellauth
Customers

Create Customer

Changed on

Creates a customer by email, or returns the existing customer with that email. The newsletter fields only apply to a newly created customer; when "created" is false, use the Set Customer Newsletter endpoint to change it.

post/v1/shops/{shopId}/customers

Request

Request body

emailstring required

The customer's email.

newsletterboolean

Whether the customer opted into the newsletter. Only send true if the customer actually consented; a subscribed customer can be targeted by your email campaigns and automations. A customer who unsubscribed themselves stays unsubscribed.

newsletter_atstring

When the customer opted in, if you are importing an existing consent. Defaults to now. Cannot be in the future.

Example request

{
  "email": "buyer@example.com"
}

Changes

  • 05f1b5c3c6c8Revision changes
    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the new optional request property