Create Smart Form

post

https://tenants-gateway-api-sbx.sidedrawersbx.com/api/v1/tenants/tenant/tenant-id/{tenantId}/smart-forms

Path Params

tenantId

string

required

Tenant identifier.

Body Params

name

array of objects

required

Name.

name*

description

array of objects

required

List of values to display the description depending on the language.

description*

brandCode

string

The affiliate code (brandCode) is an identifier for the "brand" or "affiliate" within a Tenant. The affiliate code is the version of the brand name that appears in the URL. A brand name may be "Corporate ABC", for example. Then the affiliate code might be something like "corporate-abc".

orderId

number

Priority.

sidedrawerType

string

required

Drawer (sidedrawer) type (individual as default).

sidedrawerTypeOtherName

string

Drawer (sidedrawer) type if sidedrawerType = "other".

isPublic

boolean

Entity is public.

isTemplate

boolean

Entity is a template.

reportTypeNames

array of strings

List of values of report types.

reportTypeNames

format

string

enum

Format.

Allowed:

roles

array of objects

required

Form roles.

roles*

externalKeys

array of objects

Additional key-value data.

externalKeys

createReportOnComplete

boolean

Set true if you want to create automathically the report upon completion.

triggerSignatureCollection

boolean

True if you want to trigger signature on complete.

recordTypeName

string

Hanger (recordType) name for storing the report.

recordName

string

Name of Folder (record) in which to store the report.

recordSubtypeOther

string

Folder (record) Subtype in which to store the report.

recordFileName

string

Folder (record) File for storing the report.

recordFileUploadTitle

string

Folder (record) File for storing the report.

expirationDays

number

The expiration in days.

allowComments

boolean

Allow comments.

Response

200

The given Smart form.

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here!