FOfolk
Interactions

Delete an interaction

Changed on

Delete an existing logged interaction. Imported interactions cannot be deleted.<br/><Warning>This endpoint is currently in open beta. The API surface may change as we iterate based on feedback.</Warning>

delete/v1/interactions/{interactionId}

Request

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

Path parameters

interactionIdstring required

The ID of the interaction to delete.

Query parameters

entity.idstring required

The person or company the interaction is linked to.

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 interaction.

deprecationsstring[]

Example response

{
  "data": {
    "id": "lit_b049db09-c03d-4f32-96d6-d314760add5d"
  },
  "deprecations": [
    "This field is deprecated"
  ]
}

Changes