Responses

Delete responses

delete
https://api.typeform.com/forms/{form_id}/responses

Delete responses to a form. You must specify the included_response_ids parameter.

Request

Query Parameters

included_response_ids
string

Comma-separated list of response_id values of the responses to delete. You can list up to 1000 tokens and choose to do so either in the request URL, or in its body.

Path Parameters

form_id
, required

Unique ID for the form. Find in your form URL. For example, in the URL "https://mysite.typeform.com/to/u6nXL7" the form_id is u6nXL7.

Request Body

included_response_ids
array of string

ids of responses to be deleted

Responses

Status

200 OK

Status

400 Bad request

Schema

code
string

A developer-readable snake_case key, indicating some idea of what type of error occurred.

description
string

A developer-readable description of the error, expanding on the terse code.

details Path 3
array of object

An optional object containing more detailed info regarding which field the error occurred in.

code
string

A developer-readable snake_case key, indicating some idea of what type of error occurred.

description
string

A developer-readable description about the field-level error.

field
string

Which field the error occurred. This could refer to a field in the request body, request header, or query parameter.

help
string

A URL linking to help content, to aid the client developer in resolving the error. This value should be provided whenever available.

in
string
Valid values:headerbodyquery

The type of field that caused the error.

help
string

A URL linking to help content, to aid the client developer in resolving the error. This value should be provided whenever available.

Status

401 Unauthorized

Schema

code
string

A developer-readable snake_case key, indicating some idea of what type of error occurred.

description
string

A developer-readable description of the error, expanding on the terse code.

details Path 3
array of object

An optional object containing more detailed info regarding which field the error occurred in.

code
string

A developer-readable snake_case key, indicating some idea of what type of error occurred.

description
string

A developer-readable description about the field-level error.

field
string

Which field the error occurred. This could refer to a field in the request body, request header, or query parameter.

help
string

A URL linking to help content, to aid the client developer in resolving the error. This value should be provided whenever available.

in
string
Valid values:headerbodyquery

The type of field that caused the error.

help
string

A URL linking to help content, to aid the client developer in resolving the error. This value should be provided whenever available.

Status

405 Method not allowed

Schema

code
string

A developer-readable snake_case key, indicating some idea of what type of error occurred.

description
string

A developer-readable description of the error, expanding on the terse code.

details Path 3
array of object

An optional object containing more detailed info regarding which field the error occurred in.

code
string

A developer-readable snake_case key, indicating some idea of what type of error occurred.

description
string

A developer-readable description about the field-level error.

field
string

Which field the error occurred. This could refer to a field in the request body, request header, or query parameter.

help
string

A URL linking to help content, to aid the client developer in resolving the error. This value should be provided whenever available.

in
string
Valid values:headerbodyquery

The type of field that caused the error.

help
string

A URL linking to help content, to aid the client developer in resolving the error. This value should be provided whenever available.

Status

500 Internal server error

Schema

code
string

A developer-readable snake_case key, indicating some idea of what type of error occurred.

description
string

A developer-readable description of the error, expanding on the terse code.

details Path 3
array of object

An optional object containing more detailed info regarding which field the error occurred in.

code
string

A developer-readable snake_case key, indicating some idea of what type of error occurred.

description
string

A developer-readable description about the field-level error.

field
string

Which field the error occurred. This could refer to a field in the request body, request header, or query parameter.

help
string

A URL linking to help content, to aid the client developer in resolving the error. This value should be provided whenever available.

in
string
Valid values:headerbodyquery

The type of field that caused the error.

help
string

A URL linking to help content, to aid the client developer in resolving the error. This value should be provided whenever available.