Skip to main content
POST
Creates one or more groups.

Headers

X-Delogue-Api
string

Body

name
string

Display name of the group. Required, unique within the organization, and limited to 200 characters.

userDefinedId
null | string

Optional customer-defined identifier for imports, exports, and ERP integration. Unique within the organization when set, and limited to 50 characters.

state
null | enum<string>

Initial lifecycle state of the group. Defaults to active when omitted; creating a group in the deleted state is rejected.

Available options:
active,
inactive,
deleted

Response

Created

status
enum<string>
required

The coarse outcome of the request, indicating whether it succeeded or failed.

Available options:
success,
error
code
string
required

The specific machine-readable outcome code, such as ok on success or the most specific error code on failure. Always lowercase on the wire.

data
null | object[]
required

The response payload, either a single object for a by-id read or an array for a bulk operation. Omitted from the body when there is no value.