comecerodocs

Email a sign-in link

POST
/customers/send_link

Emails a customer a link that signs them in to your app without a password, for example to see past orders and downloads. The customer is found by email address. When several customers of the account have that email, the newest gets the link and the email offers the others too (up to 10).

The link opens https://<your app host>/link and works for 4 hours. The account needs an app host in its technical settings and a notification set up for customer links, or the call fails with 422.

No token is needed. Every input is in the query string; there is no body.

Query Parameters

account_id*string

The account the customer belongs to.

app_id*string

The id of an app installed on the account. The link signs the customer in to it.

email*string

The customer's email address. Must match a customer's email exactly (not case sensitive).

Formatemail
redirect_uri?string

A relative path in the app to open after sign-in, for example /orders. A full URL with https:// is a 400.

test?boolean

true to look up a test customer.

Defaultfalse
date_start?string

Only consider customers created on or after this date (ISO 8601).

date_end?string

Only consider customers created on or before this date (ISO 8601).

date_type?string

Which customer date date_start and date_end use.

Default"date_created"
Value in"date_created""date_modified"

Response Body

The link was sent. There is no body.

Example Request
curl -X POST 'https://api.comecero.com/api/v1/customers/send_link?account_id=string&app_id=string&email=user%40example.com'
Example Response
Empty