Custom fields

Remove custom field from a project

Changed on
delete/v1/workspaces/{workspaceId}/projects/{projectId}/custom-fields/{customFieldId}

Request

  • Base URL: https://api.clockify.me/api
  • URL: https://api.clockify.me/api/v1/workspaces/{workspaceId}/projects/{projectId}/custom-fields/{customFieldId}
  • Auth: one of:
    • API key in header x-api-key
    • API key in header x-addon-token

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:64a687e29ae1f428e7ebe303
projectIdstring required

Represents a project identifier across the system.

Example:64a687e29ae1f428e7ebe303
customFieldIdstring required

Represents a custom field identifier across the system.

Example:26a687e29ae1f428e7ebe101

Response

OK

allowedValuesstring[]

Represents a list of custom field's allowed values.

descriptionstring

Represents custom field description.

entityTypestring

Represents custom field entity type

idstring

Represents custom field identifier across the system.

namestring

Represents custom field name.

onlyAdminCanEditboolean

Flag to set whether custom field is modifiable only by admin users.

placeholderstring

Represents custom field placeholder value.

requiredboolean

Flag to set whether custom field is mandatory or not.

statusstring

Represents custom field status

typestring

Represents custom field type.

workspaceDefaultValueobject

Represents a custom field's default value in the workspace.

workspaceIdstring

Represents workspace identifier across the system.

Example response

{
  "allowedValues": [
    "New York",
    "London",
    "Manila",
    "Sydney",
    "Belgrade"
  ],
  "description": "This field contains a location.",
  "entityType": "USER",
  "id": "44a687e29ae1f428e7ebe305",
  "name": "location",
  "placeholder": "Location",
  "projectDefaultValues": [
    {
      "projectId": "5b641568b07987035750505e",
      "status": "VISIBLE"
    }
  ],
  "status": "VISIBLE",
  "type": "DROPDOWN_MULTIPLE",
  "workspaceId": "64a687e29ae1f428e7ebe303"
}

Changes

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status