APIPay In endpointsCustomer

Send opt-in

View as MarkdownOpen in Claude

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

Path parameters

customerIdintegerRequired

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

Response

Success
responseTextstring

Response text for operation: ‘Success’ or ‘Declined’.

responseCodeintegerOptional

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

pageIdentifierstringOptional
Auxiliary validation used internally by payment pages and components.
roomIdlongOptional

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

isSuccessbooleanOptional

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

responseDatastring or integerOptional
The response data.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error