For the complete documentation index, see llms.txt. This page is also available as Markdown.

Send consent portal link (SMS and/or email)

Sends the customer a link to review and update consents on the public web portal. SMS is sent when the customer has a mobile number and the store has SMS configured; email when an address exists.

Each send generates a new signed link and invalidates any previously sent link for the same customer. Validity is tracked server-side (customer parameter CONSENT_PORTAL_HASH_NONCE); the link has no time-based expiry but becomes invalid when a new link is issued.

Portal URL format (served by the web app, not this API): {publicBaseUrl}/tenant/{tenantUid}/customer/{customerUid}/consents/{portalHash}

Required permissions: CUSTOMER

post
/tenants/{tenantUid}/customers/{customerUid}/consents/send-portal-link
Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
customerUidstringRequired

Reference to a Customer.

Pattern: ^[A-Za-z0-9-_]+
Body
storeUidstringRequired

Store used for SMS sender configuration and notification attribution

Responses
204

No Content

No content

post/tenants/{tenantUid}/customers/{customerUid}/consents/send-portal-link
POST /v2/tenants/{tenantUid}/customers/{customerUid}/consents/send-portal-link HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "storeUid": "text"
}
204

No Content

No content

Last updated

Was this helpful?