Status Page Contact sales

Home Platform Overview Integration Guides UI Guides API Reference Changelog

Home Platform Overview Integration Guides UI Guides API Reference Changelog

Using the API
API reference

Status Page Contact sales

API reference Pay In endpoints Customer

Send opt-in

POST

/Customer/:customerId/consent

POST

/api/Customer/:customerId/consent

1 curl -X POST https://api-sandbox.payabli.com/api/Customer/998/consent \
2      -H "requestToken: <apiKey>"

200Success example

1 {
2   "responseCode": 1,
3   "pageIdentifier": "null",
4   "isSuccess": true,
5   "responseText": "Success",
6   "responseData": " "
7 }

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 PartnerHub.

Headers

requestTokenstringRequired

Response

Success

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.

responseTextstringOptional

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

responseDatastring or integerOptional

The response data.

Errors

Was this page helpful?

Import customers