Project fields

Delete project field

Changed on

Delete a project field and its options. This cannot be undone. Requires the organization admin role.

delete/v1/organizations/{organizationId}/project-fields/{fieldId}

Request

  • Base URL: https://api.coloop.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.coloop.ai/v1/organizations/{organizationId}/project-fields/{fieldId}
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Path parameters

organizationIdstring required
fieldIdstring required

Query parameters

forceboolean

Set to true to delete a field that projects have filled in, which also deletes those values. Otherwise the request fails with 409 while any project uses the field.

Response

The project field was deleted.

Changes