Listen LabsDocs

    Endpoints

    Delete Response

    Request permanent deletion of a response and receive a deletion receipt

    DEL/api/public/v1/responses
    Request
    curl -X DELETE 'https://listenlabs.ai/api/public/v1/responses?studyId=<studyId>&responseId=<responseId>' \
      -H 'x-api-key: <api_key>'
    Response
    JSON
    {
      "deletionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "queued"
    }

    Pass both the studyId and responseId UUIDs from Search Responses. Deletion runs asynchronously and removes respondent media and response-owned data.

    The receipt contains deletionId, responseId, and status. A 202 means the deletion is queued or running; a 200 means an existing deletion is completed or failed. Repeating the request returns the same deletion ID and current status, including after the response is removed. Use Get Response Deletion Status to follow progress.

    Authorization

    x-api-keystringheaderrequired

    Your workspace API key. See Authentication.

    Query parameters

    studyIdstring<uuid>required
    responseIdstring<uuid>required

    Responses

    Existing deletion completed or failed.

    deletionIdstring<uuid>required
    responseIdstring<uuid>required
    statusstringrequired

    One of: queued, running, completed, failed