Skip to main content
PUT
Bulk-updates and/or soft-deletes groups in a single transaction.

Headers

X-Delogue-Api
string

Body

id
integer<int64>
required

Identifier of the group this bulk item updates or soft-deletes. Required on every bulk-update item.

name
null | string

Display name of the group, limited to 200 characters. Required on full-replace PUT; on PATCH an omitted name keeps its stored value.

userDefinedId
null | string

Customer-defined identifier for ERP integration, limited to 50 characters. On PUT a null value clears it; on PATCH an omitted value is preserved and a null clears it.

state
null | enum<string>

Lifecycle state of the group, required on update. On single PUT and PATCH the deleted state is rejected in favor of DELETE; on bulk PUT it routes the item through soft-delete.

Available options:
active,
inactive,
deleted

Response

OK

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.