Create a structure

Creates a structure, such as a site or a group, within your organization. Set parent_structure_id to place the new structure beneath an existing one, or leave it empty to create a top-level structure. Field values supplied in fields are applied to the new structure.

Creates a structure within your organization and returns it. A structure is any node you assign people to, most often a site or a group, but also any structure type your organization has defined.

Set structure_type_id to the type the new structure should take. Set parent_structure_id to place it beneath an existing structure, or leave it empty to create a top-level structure. Only types that support hierarchy accept a parent.

Requirements

Field values are set by ID, so creating a structure with field values takes two calls. Resolve the IDs first with the List fields endpoint, filtering by the structure type they apply to, then pass them in fields. Each entry names a field by field_id and carries exactly one typed value matching that field's type.

πŸ“˜

A field that is marked required for the structure's type must be given a value in fields. Creating a structure without it will fail.

Body Params
string
required

Name of the structure

string
required

Structure type ID

string

Parent structure ID

string

Child structure ID

fields
array of objects

The fields for the structure

fields
string

The updated description for the structure (optional)

string

Optional. The meta label only used for top-level structures, used to identify the hierarchy level type
(e.g. "location", "area", "region", "state", "country"). ignored if parent_structure_id is provided.
use cases: create a solo structure without parent but still want to assign a meta label to it,

Responses

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