Project Field

Delete Project Field

DEL

Deletes an existing ProjectField within your Workspace.

A ProjectField is a custom field defined within your Workspace. You can define ProjectFields for any integration purpose that is important to your business. Each ProjectField has a data type as well as options in how it is handled. ProjectFields can be edited for each Project within your Workspace.

Request

This endpoint expects an object.
id
stringOptional
The unique identifier of the ProjectField being deleted
name
stringOptional
The name of the ProjectField being deleted

Response

This endpoint returns an object
error
objectOptional
If the API call failed, this will contain information about the error that occurred.
success
booleanOptional
True if the API call succeeded; false otherwise.
hasError
booleanOptional
True if the API call failed.
statusCode
enumOptional
The HTTP code of the response.
DEL
1curl -X DELETE /project-api/public/projects/fields \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{}'
200Deleted
1{
2 "error": {
3 "message": "message"
4 },
5 "success": true,
6 "hasError": true,
7 "statusCode": "Continue"
8}