API referencePay Ops endpointsBoardingTemplates

Create template

Creates a boarding template in an organization.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

orgIdintegerRequired
The numeric identifier for organization, assigned by Payabli.

Request

This endpoint expects an object.
orgIdlongOptional
The ID of the organization the template belongs to.
pricingIdlongOptional
templateCodestringOptional
The internal code for the template.
templateContentobjectOptional
templateDescriptionstringOptional
A description for the template.
templateNamestringOptional
The template name.

Response

Success
isSuccessboolean

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

pageIdentifierstring
Auxiliary validation used internally by payment pages and components.
responseCodeinteger

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

responseDatastring or integer
When the operation is successful, contains the template's ID.
responseTextstring

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

Errors

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