Orbiq logoTrust Center Documentation
API v1 ReferenceCustom tabsId

Update a custom tab

Update a custom tab. Every field is optional, so send only what changes. Content is stored per locale: `locale` selects which one is written, defaulting to…

PATCH
/api/v1/custom-tabs/{id}

Update a custom tab. Every field is optional, so send only what changes.

Content is stored per locale: locale selects which one is written, defaulting to the tenant's default locale, and it must be one the tenant has enabled. Sending intent: delete_translation with a non-default locale removes that translation instead of writing it. On the default locale, variant_options replaces assignments on every tenant-owned custom navigation row linked to this content. Omission preserves assignments and [] clears them. A non-empty explicit assignment can create the missing navigation row through the existing navigation flow. Secondary-locale and translation-delete requests reject variant_options.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Custom tab identifier

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Every field of CustomTabCreate, all optional, plus the locale controls.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://app.orbiqhq.com/api/v1/custom-tabs/$TAB_ID" \  -H "Authorization: Bearer $ACCESS_TOKEN" \  -H "Content-Type: application/json" \  -d '{"title":"Vendor Assurance"}'
{  "success": true,  "data": {    "customTab": {      "id": "string",      "tenant": "string",      "slug": "string",      "title": "string",      "order": 0,      "enabled": true,      "access_level": "public",      "content": {        "layers": [          {}        ],        "variables": [          {}        ]      },      "content_schema_version": "string",      "date_created": "2019-08-24T14:15:22Z",      "date_updated": "2019-08-24T14:15:22Z",      "translations": [        {          "id": "string",          "languages_code": "string",          "title": "string"        }      ],      "variant_options": [        {          "variant_options_id": "string"        }      ]    }  }}

How is this guide?