Update parts of a custom tab
Partially update a custom tab, including translations and layout content.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
id*string
Custom tab ID.
Match
^[a-zA-Z0-9-]+$Length
1 <= length <= 64Request Body
application/json
slug*string
Match
^[a-z0-9]+(?:-[a-z0-9]+)*$Length
1 <= lengthtitle?string
Length
1 <= lengthtranslations?array<>
content?
content_schema_version?string
order?integer
Range
0 <= valueenabled?boolean
access_level?string
Value in
"public" | "restricted" | "requires_nda" | "internal"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-123" \ -H "Content-Type: application/json" \ -d '{ "enabled": true, "translations": [ { "languages_code": "de-DE", "title": "Anbieterprüfung" } ] }'{
"success": true,
"data": {
"customTab": {
"id": "tab-123",
"slug": "vendor-assurance",
"title": "Vendor Assurance",
"enabled": true,
"access_level": "public",
"content": {
"layers": []
},
"date_created": "2024-05-12T10:11:12Z",
"date_updated": "2024-06-01T09:10:11Z"
}
}
}{
"code": "validation_error",
"message": "Invalid input.",
"details": "Provide a valid CustomTabUpdate payload."
}{
"code": "unauthorized",
"message": "Authentication required.",
"details": "Include a valid Authorization header."
}{
"code": "forbidden",
"message": "You do not have access to update this tab.",
"details": "Ensure your role allows editing custom tabs."
}{
"code": "not_found",
"message": "Custom tab not found.",
"details": "Confirm the tab id in the admin center."
}{
"code": "internal_error",
"message": "Unexpected server error.",
"details": "Try again or contact support."
}How is this guide?