Customer

Request consent opt-in

Sends the consent opt-in email to the customer email address in the customer record.

post/Customer/{customerId}/consent

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/Customer/{customerId}/consent
  • Auth: HTTP bearer

Path parameters

customerIdinteger required

Payabli-generated customer ID. Maps to "Customer ID" column in the Payabli Portal.

Response

Success

responseCodeinteger

Code for the response. Learn more in API Response Codes.

pageIdentifierstring

Auxiliary validation used internally by payment pages and components.

roomIdinteger

Describes the room ID. Only in use on Boarding endpoints, returns 0 when not applicable.

isSuccessboolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

responseTextstring required

Response text for operation: 'Success' or 'Declined'.

Changes

No recorded changes to this operation across all 1 revision of this API.