API reference

Delete a stored response.

DELETE

/responses/{response_id}

const url = 'https://api.helping.io/v1/responses/example';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://api.helping.io/v1/responses/example \
  --header 'Authorization: Bearer <token>'

The response stops being readable and can no longer be continued. The rest of its conversation is untouched. Deleting twice is not an error.

Only the key that created the response can delete it.

Authorizations

api_key

Parameters

Path Parameters

response_id

required

string

The opaque resp_... id of the response to delete

Responses

200

{id, object: "response.deleted", deleted: true}. The response stops being readable and can no longer be continued; the rest of its conversation is untouched. Deleting the same response twice is not an error.

401

Missing or invalid API key (the error envelope)

403

The key is not entitled to what the request asked for (the error envelope)

404

No such response, or one this key cannot reach.

429

This organization has exhausted its delete and cancel allowance; retry after the Retry-After header.

500

The request could not be completed; quote the x-request-id response header when reporting it.

503

The request could not be served this instant; retry after the Retry-After header.