Skip to the page

Praecise Platform

Rivier/ Reference/ contacts

Send a sign-in code and link to an address as a test

post/customer-accounts/test-link

Send a sign-in code and link to an address as a test. In test mode the mail goes only to the project's test addresses.

Before you call

Credential: Authorization: Bearer $KEY
Scope: contacts:admin
Graphql: Mutation.contactsCustomerAccountTestLink
Sdk: contacts.customerAccount.testLink
Cli: contacts customer account test link

Request bodyapplication/json, required

emailstring (email)required
At most 254 characters.
projectstring
At most 80 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/test-link' \
  -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