Payabli Docs

curl https://api-sandbox.payabli.com/api/Templates/get/80 \
     -H "requestToken: <apiKey>"

{
  "addPrice": true,
  "boardingLinks": [
    {
      "acceptOauth": false,
      "acceptRegister": false,
      "entryAttributes": "entryAttributes",
      "id": 91,
      "lastUpdated": "2022-07-01T15:00:01Z",
      "orgParentName": "PropertyManager Pro",
      "referenceName": "payabli-00710",
      "referenceTemplateId": 1830,
      "templateCode": "templateCode",
      "templateName": "SMB"
    }
  ],
  "createdAt": "2022-07-01T15:00:01Z",
  "idTemplate": 1000000,
  "isRoot": false,
  "orgParentName": "PropertyManager Pro",
  "recipientEmailNotification": true,
  "resumable": false,
  "templateCode": "templateCode",
  "templateContent": {
    "businessData": {
      "visible": true
    },
    "documentsData": {
      "minimumDocuments": 1,
      "subFooter": "subFooter",
      "subHeader": "subHeader",
      "uploadDocuments": true,
      "visible": true
    },
    "ownershipData": {
      "multipleContacts": true,
      "multipleOwners": true,
      "subFooter": "subFooter",
      "subHeader": "subHeader",
      "visible": true
    },
    "processingData": {
      "subFooter": "subFooter",
      "subHeader": "subHeader",
      "visible": true
    },
    "salesData": {
      "salesCode": "salesCode",
      "salesCRM": "salesCRM"
    },
    "servicesData": {
      "subFooter": "subFooter",
      "subHeader": "subHeader",
      "visible": true
    },
    "underwritingData": {
      "method": "automatic",
      "policyId": "J-itEyD6A7y5S5yYFjxOrb"
    }
  },
  "templateDescription": "templateDescription",
  "templateTitle": "templateTitle",
  "usedBy": 1
}

Retrieves a boarding template's details by ID.

Authentication

requestTokenstring

API Key authentication via header

Path parameters

templateIddoubleRequired

The boarding template ID. Can be found at the end of the boarding template URL in PartnerHub. Example: https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80. Here, the template ID is 80.

Response

Success

addPriceboolean

boardingLinkslist of objects

createdAtdatetime

Timestamp of when record was created, in UTC.

idTemplatelong

isRootboolean

When true, indicates that this is the organization’s root template.

orgParentNamestring

The name of the parent organization.

recipientEmailNotificationboolean

When true, Payabli will send the applicant a boarding link. Set this value to false if you are sending pre-filled applications via the API and don’t want Payabli to send the applicant an email to complete the boarding application.

resumableboolean

When true, the applicant can save an incomplete application and resume it later. When false, the applicant won’t have an option to save their progress, and must complete the application in one session.

templateCodestring

The internal code for the template.

templateContentobject

templateDescriptionstring

templateTitlestring

usedByinteger

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error