Delete response

DELETE

/v2/tenant/{tenantKey}/registered/{responseKey}

const url = 'https://sender.api.kivra.com/v2/tenant/example/registered/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://sender.api.kivra.com/v2/tenant/example/registered/example \
  --header 'Authorization: Bearer <token>'

Delete a registered letter response. Automatically deleted after 30 days.

Authorizations

oAuth2Client
delete:kivra.v1.tenant.{tenantKey}

Parameters

Path Parameters

tenantKey

required

string format: hexadecimal

The tenant key for the tenant who sent the registered letter.

responseKey

required

string format: hexadecimal

The unique key of a registered letter response.

Responses

204

Registered letter response deleted.

400

Can’t process the request. Likely due to a client error.

401

Not authorized to make the request.

403

Forbidden from accessing the registered letter response.

404

The registered letter response does not exist.