Skip to content

Start sign-up

POST
/api/website/customers/register
curl --request POST \
--url https://api.petanqueai.com/api/website/customers/register \
--header 'Content-Type: application/json' \
--header 'x-storefront-token: <x-storefront-token>' \
--data '{ "email": "hello@example.com", "name": "example", "password": "example", "phone": "example", "smsConsent": true, "verifyUrl": "https://example.com" }'

Emails the shopper a link to verify their address. No account exists until they open it and your site calls Verify email.

verifyUrl is the page on your site that receives the link; Petanque AI appends ?token=…. Its origin must be on your shop’s allowed origins (Ayarlar → Web Sitesi), otherwise 422. The link is valid for 24 hours.

Answers 202. 409 if the address already has an account with a password. Limited to 5 sign-ups per address per hour.

object
email
required
string format: email
>= 3 characters <= 320 characters
name
required
string
>= 1 characters <= 200 characters
password
required
string
>= 8 characters <= 200 characters
phone
string
<= 50 characters
smsConsent
boolean
verifyUrl
required
string format: uri
<= 2048 characters

Example generated

{
"email": "hello@example.com",
"name": "example",
"password": "example",
"phone": "example",
"smsConsent": true,
"verifyUrl": "https://example.com"
}