Contacts customer auth code

post/customer-accounts/auth/code

Send a customer a sign-in code, from the project's own server (a platform on its own domain). The same rules as the hosted form: sign-up as the project allows, limits per address and per network (pass the customer's ip).

Before you call

Credential: Authorization: Bearer $KEY
Scope: contacts:write
Sdk: contacts.customerAuth.code
Cli: contacts customer auth code

Request bodyapplication/json, required

projectstring
At most 80 characters.
emailstring (email)required
At most 254 characters.
localestring
At most 12 characters.
namestring
At most 120 characters.
ipstring
At most 64 characters.
userAgentstring
At most 200 characters.

Responses

200application/json
Success
object
400application/json
The request was malformed
- errorstringrequired
- messagestring
401application/json
No valid credential
- errorstringrequired
- messagestring
403application/json
The credential lacks the scope, origin or address
- errorstringrequired
- messagestring
429application/json
Over the key's rate limit; see Retry-After
- errorstringrequired
- messagestring

Example request

curl -X POST 'https://api.rivier.ai/customer-accounts/auth/code' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "name@example.com"
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown