Fields

Reconfigure field

Requirements:<br/>- auth-client scopes: "workspace"<br/>- user permission: "full"<br/>- team features: "team-fields" when operating with team-fields<br/>- user role: "admin" when operating with team-fields

put/api/fields/{fieldId}

Request

  • Base URL: https://app.airfocus.com
  • URL: https://app.airfocus.com/api/fields/{fieldId}
  • Auth: HTTP bearer

Path parameters

fieldIdstring uuid required

ID of the target field.

Query parameters

actAsAdminboolean

Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.

Request body

descriptionstring required
isTeamFieldboolean required
namestring required
requiredboolean

Response

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example response

{
  "_embedded": {
    "workspaces": [
      {
        "order": 42
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.