PATCH /api/builder/pages/{page_id}/

Updates an existing page of an application builder

Servers

Path parameters

Name Type Required Description
page_id Integer Yes

The id of the page

Request headers

Name Type Required Description
ClientSessionId String No

An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone.

Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
visibility String No

Controls the page's visibility. When set to 'logged-in', the builder's login_page must also be set.

  • all - All
  • logged-in - Logged In

Possible values:

  • "logged-in"
  • "all"
name String No
roles No

List of user roles that are associated with this page. Used in conjunction with role_type.

query_params[] Array No
query_params[].name String Yes

The name of the parameter.

query_params[].type String Yes

The type of the parameter.

  • text - text
  • numeric - numeric

Possible values:

  • "numeric"
  • "text"
path_params[] Array No
path_params[].name String Yes

The name of the parameter.

path_params[].type String Yes

The type of the parameter.

  • text - text
  • numeric - numeric

Possible values:

  • "numeric"
  • "text"
path String No
role_type String No

Role type is used in conjunction with roles to control access to this page.

  • allow_all - Allow All
  • allow_all_except - Allow All Except
  • disallow_all_except - Disallow All Except

Possible values:

  • "disallow_all_except"
  • "allow_all_except"
  • "allow_all"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.