Create custom field

Create a new custom field.

POST
/ beta / workspaces / {workspaceId} / custom-fields

Authorization

  • X-API-Key
    string
    required

    Header with the name X-API-Key where the value is your API key.

Path parameters

  • workspaceId
    string
    required

    The workspace in which a custom field should be created.

Body

application/json

  • type
    string
    required

    The type of custom field. "text", "url", "date", "person", "multiPerson", "phone", "select", "multiSelect", "number", "email", "checkbox", and "relatedTo" are all valid options.

  • name
    string
    required

    The name of the custom field.

  • metadata
    object

    A configuration object used for advanced custom fields, like single-select, multi-select, checkboxes, and numbers.

Response

200 - application/json - object

  • id
    string
    required

    The ID of the custom field.

  • type
    string
    required

    The type of custom field. "text", "url", "date", "person", "multiPerson", "phone", "select", "multiSelect", "number", "email", "checkbox", and "relatedTo" are all valid options.