Skip to content

Update#

Update a Custom Field (requires manageCustomField permission).

Query#

PATCH /api/customField/{id}

with:

  • id: id or name of the custom field.

Request Body Example#

{
    "name": "Business Unit",
    "reference": "businessUnit",
    "description": "Targetted business unit",
    "type": "string",
    "options": [
        "Sales",
        "Marketing",
        "VIP",
        "Security",
        "Sys admins",
        "HR",
        "Procurement",
        "Legal"
    ],
    "mandatory": false
}

No fields are required.

Response#

Status codes#

  • 200: if Custom Fields is updated successfully
  • 401: Authentication error
  • 403: Authorization error

ResponseBody Example#

{
  "id": "~32912",
  "name": "Business Unit",
  "reference": "businessUnit",
  "description": "Targetted business unit",
  "type": "string",
  "options": [
    "HR",
    "Legal",
    "Marketing",
    "Procurement",
    "Sales",
    "Security",
    "Sys admins",
    "VIP"
  ],
  "mandatory": false
}

{
  "type": "AuthenticationError",
  "message": "Authentication failure"
}

{
  "type": "AuthorizationError",
  "message": "Your are not authorized to update custom field, you haven't the permission manageCustomField"
}
Last update: September 6, 2021 05:39:12