FOfolk
People

Delete a person

Changed on

Delete an existing person in the workspace.

delete/v1/people/{personId}

Request

  • Base URL
    https://api.folk.app
  • URL
    https://api.folk.app/v1/people/{personId}
  • Auth
    HTTP bearer

Path parameters

personIdstring required

The ID of the person to delete.

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

Response

The ID of the deleted person.

deprecationsstring[]

Example response

{
  "data": {
    "id": "per_183ed5cc-3182-45de-84d1-d520f2604810"
  },
  "deprecations": [
    "This field is deprecated"
  ]
}

Changes

  • c6818f3ba60dRevision changes
    • info

      added the new optional header request parameter Idempotency-Key

    • info

      added the non-success response with the status

    • info

      the response property / became required for the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status