POST/desk/api/v2/customfields.json

Create a new customfield.

Body Params

    • Name
      customfield
      Type
      object
      Description
      CustomField represents a CustomField.
    • Name
      included
      Type
      object
      Description
      Included allows adding referenced objects on the API response. The included keys should map to the `types` in the Relationship slices/objects.

    Responses

    • Code
      201
      Type
      object
      Schema
      Description
      201 Created
    • Code
      400
      Type
      object
      Schema
      Description
      400 Bad Request
      Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.

    Examples

    201 Created

    CustomFieldAPIBody
    {  "customfield": {    "addToNewInboxes": true,    "agentLabel": "string",    "agentRequired": true,    "apps": [      {        "delete": true,        "id": 0,        "meta": {          "additionalProp": "Unknown Type: any"        },        "type": 0      }    ],    "createdAt": "2025-01-29T11:35:55.315Z",    "createdBy": {      "delete": true,
    Download Swagger