profile-tab

Update an existing profile tab

patch/v1/org/{orgId}/profile-tab/{profileTabId}

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/org/{orgId}/profile-tab/{profileTabId}
  • Auth: none declared

Path parameters

orgIdstring required

Org identifier (either id or slug)

profileTabIdstring required

Profile tab id

Request body

labelstring

human-readable name of profile tab

status'ACTIVE' | 'INACTIVE'

status of the profile tab

targetFilterstring

filter that controls on which profiles this tab will appear

readFilterstring

filter that controls which viewers can read this profile tab. The profileTab:read permission, if present, overrides this filter

sortinteger

sort order

Example request

{
  "label": "Performance",
  "blocks": [
    {
      "formIds": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ],
  "layout": {
    "rows": [
      {
        "columns": [
          {
            "blocks": [
              {
                "formIds": [
                  "588f7ee98f138b19220041a7"
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

Response

updated

Changes

No recorded changes to this operation across all 20 revisions of this API.