Replace a catalogue
Header Parameters
Path Parameters
Company ID. Must be one of the IDs returned by GET /api/v2/companies/.
Row id. A row belonging to another company is 404 on every verb, never 403.
Body Parameters
Locale-keyed names, e.g. {"en": "Provisions", "de": "Verpflegung"}. The en value is what ?ordering=name sorts on, whatever language the key's user has.
Show child attributes
Legal entity ids. Must belong to this company.
Show child attributes
Response
Updated. The body is the read shape.
Response Attributes
Locale-keyed names, e.g. {"en": "Provisions", "de": "Verpflegung"}. The en value is what ?ordering=name sorts on, whatever language the key's user has.
Show child attributes
Read-only. Together with assignedDepartmentsNotAllowed this decides which people see the catalogue; the flag inverts the gate, so a key must not rewrite it.
Show child attributes
Read-only. true means the departments listed are the ones excluded.
Legal entities the catalogue applies to.
Show child attributes
When the row was created.
When the row itself last changed.
null on a live row; the timestamp of the soft delete otherwise. Read-only everywhere.
Validation failed.
Response Attributes
validationErrorclientErrorserverError Show child attributes
Missing, invalid, or expired API key, or a session credential was used instead of an API key.
Response Attributes
validationErrorclientErrorserverError Show child attributes
Authenticated but not entitled: the key's user is not an active member of this company, the External API feature (or the resource's own feature) is not enabled for it, the key lacks the scope this verb needs, or a browser session was used.
Response Attributes
validationErrorclientErrorserverError Show child attributes
No such row for this company, including a row that belongs to another company, and a soft-deleted row you tried to write to. The API does not confirm whether the id exists elsewhere.
Response Attributes
validationErrorclientErrorserverError Show child attributes
Rate limit exceeded (60 requests per minute per API key). Retry after the number of seconds given in the message.
Response Attributes
validationErrorclientErrorserverError