CorebanqCorebanq Developer Docs
Itemsv1

Create new set item

Attaches an item to a record of another type. The permission checked is READ on record_type/record_id — the record the item is being attached to, not the item. A caller without READ on that record is refused with 403 `common.rbac_no_rec_access`. Accept-Language is not read on this route: only GetItem and ListItems pull constants.AcceptLanguage from the request, and this 201 body carries no localised fields.

POST
/v1/items/set

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/items/set" \  -H "Content-Type: application/json" \  -d '{    "record_id": "8bf519b6-a3e0-49d2-8e42-039542d9a489",    "record_type": "customers",    "type": "string",    "name": "string"  }'
{
  "record_id": "8bf519b6-a3e0-49d2-8e42-039542d9a489",
  "record_type": "string",
  "type": "string",
  "name": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
  "modified_at": "2019-08-24T14:15:22Z",
  "modified_by": "e8d4374d-93a1-4e98-a6c6-fdcf00c5059f",
  "active": true,
  "metadata": {}
}
{
  "status": 409,
  "message": "Item with this name already exists",
  "code": "items_m.item_name_exists",
  "class": "business",
  "retryable": false,
  "details": [
    {
      "field": "title",
      "rule": "required",
      "param": "string",
      "message": "title is required"
    }
  ]
}
{
  "status": 409,
  "message": "Item with this name already exists",
  "code": "items_m.item_name_exists",
  "class": "business",
  "retryable": false,
  "details": [
    {
      "field": "title",
      "rule": "required",
      "param": "string",
      "message": "title is required"
    }
  ]
}
{
  "status": 409,
  "message": "Item with this name already exists",
  "code": "items_m.item_name_exists",
  "class": "business",
  "retryable": false,
  "details": [
    {
      "field": "title",
      "rule": "required",
      "param": "string",
      "message": "title is required"
    }
  ]
}
{
  "status": 429,
  "message": "rate limit exceeded",
  "code": "rate_limits_m.exceeded",
  "class": "temporary",
  "retryable": true
}
{
  "status": 409,
  "message": "Item with this name already exists",
  "code": "items_m.item_name_exists",
  "class": "business",
  "retryable": false,
  "details": [
    {
      "field": "title",
      "rule": "required",
      "param": "string",
      "message": "title is required"
    }
  ]
}

{
  "overall_status": "unhealthy",
  "message": "Service is shutting down",
  "timestamp": "2026-08-27T15:04:05Z"
}

DELDelete item

Deletes the item. System items cannot be deleted. A caller without the delete permission on items is refused with 403 `common.rbac_no_rec_access`. THE DELETE IS PERMANENT. models.Item embeds models.BaseModel, which carries no gorm.DeletedAt, so this issues a real DELETE FROM misc.items — the row is gone, not deactivated, and setting active=false is a different operation with a different outcome. A system item is refused with 400 items_m.system_item_cannot_be_deleted, but that protection is not durable: PUT /v1/items/{id} accepts "system": false, so a caller with update rights can clear the flag and then delete the item.

Description

Next Page