Company logoTrust Center Documentation

Update a tab row

Update the order or enabled state for a tab row owned by the authenticated tenant. Use this endpoint for drag-and-drop ordering and visibility toggles.…

PATCH
/api/v1/tabs/{id}

Update the order or enabled state for a tab row owned by the authenticated tenant. Use this endpoint for drag-and-drop ordering and visibility toggles. Legacy synthetic custom tab IDs such as custom-* are rejected; pass the Directus tab row ID returned by GET /api/v1/tabs.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Directus tab row ID.

Formatuuid
Length1 <= length

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

curl -X PATCH "https://example.com/api/v1/tabs/3f8b1f4e-7b2a-4f68-8b1b-8d5c3d1e9f42" \  -H "Content-Type: application/json" \  -d '{    "order": 3  }'
{
  "success": true,
  "data": {
    "tab": {
      "id": "3f8b1f4e-7b2a-4f68-8b1b-8d5c3d1e9f42",
      "tenant": "tenant-123",
      "kind": "custom",
      "system_tab": null,
      "custom_tab": "tab-vendor-assurance",
      "order": 3,
      "enabled": false
    }
  }
}

{
  "error": "Invalid tab row ID"
}

{
  "error": "string",
  "code": "string",
  "message": "string",
  "details": "string"
}
{
  "error": "string",
  "code": "string",
  "message": "string",
  "details": "string"
}
{
  "error": "Tab row not found"
}
{
  "error": "string",
  "code": "string",
  "message": "string",
  "details": "string"
}

How is this guide?