Sign in
Elements Configs (EAP)

Create Elements Config

Creates a new elements_config under the active organization.

post/v2/elements/{proj_id}/{env_id}/config

Path parameters

proj_idstring required

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

env_idstring required

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

Request body

keystring required

A URL-friendly name of the elements_config (i.e: slug). You will be able to query later using this key instead of the id (UUID) of the elements_config.

namestring required

The name of the elements_config

elements_type'user_management' | 'audit_log' | 'approval_flow' | 'operation_approval' | 'approval_management' required

An enumeration.

settingsobject required

Obj with the options of the elements interface, e.g: primary color

email_notificationsboolean

Whether to send email notifications to users using your Email Provider you set

roles_to_levelsobject required

Obj with levels as keys and role ids as values

Response

Successful Response

keystring required

A URL-friendly name of the elements_config (i.e: slug). You will be able to query later using this key instead of the id (UUID) of the elements_config.

idstring uuid required

Unique id of the elements_config

organization_idstring uuid required

Unique id of the organization that the elements_config belongs to.

project_idstring uuid required

Unique id of the project that the elements_config belongs to.

environment_idstring uuid required

Unique id of the environment that the elements_config belongs to.

created_atstring date-time required

Date and time when the elements_config was created (ISO_8601 format).

updated_atstring date-time required

Date and time when the elements_config was last updated/modified (ISO_8601 format).

is_activeboolean required
namestring required

The name of the elements_config

elements_type'user_management' | 'audit_log' | 'approval_flow' | 'operation_approval' | 'approval_management' required

An enumeration.

settingsobject required

Obj with the options of the elements interface, e.g: primary color

email_notificationsboolean

Whether to send email notifications to users using your Email Provider you set

roles_to_levelsobject required

Obj with levels as keys and role ids as values

Changes

No recorded changes to this endpoint across all 8 revisions of this API.