FOfolk
Companies

Delete companies in batch

Changed on

Delete up to 100 existing companies in the workspace. Each record is deleted on its own: one that fails does not prevent the others from being deleted.

post/v1/companies/batch/delete

Request

  • Base URL
    https://api.folk.app
  • URL
    https://api.folk.app/v1/companies/batch/delete
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring

A unique key, such as a UUID, that makes retrying this request safe: a retry with the same key and body returns the original response without running the operation again. Keys are kept for 24 hours after the request completes.

Example:8e03978e-40d5-43e8-bc93-6894a57f9324

Request body

Example request

{
  "records": [
    {
      "id": "com_183ed5cc-3182-45de-84d1-d520f2604810"
    }
  ]
}

Response

The outcome of each record, with the ID of each deleted company.

deprecationsstring[]

Example response

{
  "data": {
    "results": [
      {
        "status": "succeeded",
        "data": {
          "id": "com_183ed5cc-3182-45de-84d1-d520f2604810"
        }
      },
      {
        "status": "failed",
        "error": {
          "code": "NOT_FOUND",
          "message": "Not found.",
          "documentationUrl": "https://developer.folk.app/api-reference/errors#not-found"
        }
      }
    ]
  },
  "deprecations": [
    "This field is deprecated"
  ]
}

Changes