API Reference

Update Plan Request

put
https://tenants-gateway-api-sbx.sidedrawersbx.com/api/v1/tenants/tenant/tenant-id//plans/plan-id/
Path Params
string
required

Tenant identifier.

string
required

Unique Plan 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*
number

Priority.

boolean

Entity is public.

boolean

Entity is a template.

reportTypeNames
array of strings

List of values of report types.

reportTypeNames
string
enum

Format.

Allowed:
externalKeys
array of objects

Additional key-value data.

externalKeys
screens
array of objects

To split the Info Request across different Screens.

screens
number

The Info Request expiration in days.

Response
200

The given Plan.

Updated 10 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated 10 months ago

Did this page help you?