Unlinks a custom field definition from a workflow.

POST

https://api.awork.com/api/v1/workflows/:workflowId/unlinkcustomfielddefinition

Required Permissions

The user must be an admin or have project-manage-config:write permissions.

<Check title="Required Permissions" icon="key">The user must be an admin or have `project-manage-config:write` permissions.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

workflowIdstringRequiredformat: "uuid"

Request

This endpoint expects an object.

customFieldDefinitionIdstringRequiredformat: "uuid"

The id of the custom field definition.

unlinkCustomFieldFromLinkedProjectsbooleanOptional

Gets or sets a value indicating whether the custom field should also be unlinked from workflow-linked projects, including deleting task custom field values.

Response

No Content

Errors

400

Bad Request Error

404

Not Found Error

$	curl -X POST https://api.awork.com/api/v1/workflows/workflowId/unlinkcustomfielddefinition \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"customFieldDefinitionId": "123e4567-e89b-12d3-a456-426614174000"
>	}'