Replace a structure

Replaces a structure's name, description and field values. This is a full replacement, not a partial update: an omitted description is cleared, and any field value that is not present in fields is cleared. Send the structure's complete field set on every request.

Use this endpoint to set a structure's name, description, and field values in one call. It is a full replacement, and any you leave out is cleared. For example, an omitted description clears the existing description, and any field value not present in fields is cleared from the structure.

To change one attribute safely, read the structure with the Get a structure endpoint, apply your change to the result, and send the complete set back. If you prefer to change a structure's position in the hierarchy, use the Move a structure endpoint instead.

Requirements

πŸ“•

Sending a request with an empty fields array clears every field value on the structure. This is not reversible.

Path Params
string
required

The identifier of the structure to update

Body Params
string

The updated name of the structure

string

The updated description for the structure (optional)

fields
array of objects

The updated fields for the structure

fields
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json