Create Plan Request Item

post

https://tenants-gateway-api-sbx.sidedrawersbx.com/api/v1/tenants/tenant/tenant-id/{tenantId}/plans/plan-id/{planId}/items

Path Params

tenantId

string

required

Tenant identifier.

planId

string

required

Unique Plan identifier.

Body Params

name

string

required

Item name.

recordTypeName

string

Hanger (recordType) name.

recordSubtypeName

string

Folder (record) Subtype name.

recordSubtypeOtherName

string

Folder (record) Subtype name if recordSubtypeName = "other".

info

array of objects

Info.

info

itemType

string

enum

Item type.

Allowed:

validation

object

Validation to perform over the field (required for field item type).

orderId

number

Priority.

optional

boolean

Defaults to false

Optional.

uniqueRecord

boolean

Defaults to false

Unique Folder (record).

defineRecordName

object

Define Folder (record) name.

suggestedRecordName

array of objects

Suggested Folder (record) name.

suggestedRecordName

screenName

string

To split the items in screens if necessary.

Response

200

The given Plan.

Language

Credentials

Bearer

JWT

Loading…

Response

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