Delete a custom field definition

DELETE

/boards/{board}/custom-fields/definitions/{definition}

const url = 'https://projects.work.optidata.cloud/api/boards/1/custom-fields/definitions/1';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://projects.work.optidata.cloud/api/boards/1/custom-fields/definitions/1 \
  --header 'Authorization: Bearer <token>'

Soft-deletes the definition; existing stored values stop being shown on cards.

Authorizations

bearerAuth

Parameters

Path Parameters

board

required

integer

Board id.

definition

required

integer

Custom field definition id.

Responses

204

Definition deleted. No content.

401

Missing, invalid or expired bearer passport.

application/json

object

error

string

Example

{
  "error": "JWT passport exception: Missing bearer token in request"
}

403

The authenticated user lacks the required board permission.

application/json

object

message

string

Example

{
  "message": "This action is unauthorized."
}

404

Resource not found, or a nested resource does not belong to its parent in the path.

application/json

object

message

string

Example

{
  "message": "Not found."
}