Delete form response

DELETE

/v2/tenant/{tenantKey}/form/{formTemplateKey}/responses/{formResponseKey}

const url = 'https://sender.api.kivra.com/v2/tenant/example/form/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/responses/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
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/form/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/responses/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Given a tenant key, form template key and form response key deletes the form response submitted by a user.

Only the client that created the form template associated with the response can call this endpoint.

Form responses potentially contain sensitive data. You are recommended to delete form responses from Kivra as you consume them.

Authorizations

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

Parameters

Path Parameters

tenantKey

required

string format: hexadecimal

The unique Key for a Tenant for whom the form belongs to.

formTemplateKey

required

string format: uuid

The form_template_key associated with the form template.

formResponseKey

required

string format: uuid

The form response key associated with the form responses.

Responses

204

Form 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 form response keys

404

Either the form template associated with the given formTemplateKey does not exist or the form response associated with the given responseKey does not exist.