Journey Docs
Partner API ExplorerPublic

Send a custom-loyalty sign-in link

POST
/v1/public/partner/custom-loyalty/invite/send

Emails a sign-in link to a visitor of a partner-hosted custom loyalty page. The only unauthenticated endpoint on the partner surface: it is called by the partner’s own public page on behalf of a visitor, so it carries no credential. The organization is resolved from host, which must be a domain the partner has connected. Rate limited to 30 requests per 15 minutes.

Request Body

application/json
  1. body
email*string
Formatemail
Lengthlength <= 320
firstName?string
Lengthlength <= 100
host*string
Lengthlength <= 300
pageTitle?string
Lengthlength <= 200
returnPath?string
Lengthlength <= 2000

Response Body

The request was accepted. The response does not reveal whether the address belongs to an existing member.

application/json
  1. response
ok*boolean
curl -X POST 'https://api-prd.cf.journey.com/v1/public/partner/custom-loyalty/invite/send' \  -H 'Content-Type: application/json' \  -d '{  "email": "user@example.com",  "host": "string"}'
{  "ok": true}