Remove a question from its survey

DELETE

/elements/{id}

curl --request DELETE \
  --url https://app.surveyrock.com/api/v1/elements/example \
  --header 'Authorization: Bearer <token>'

• API v1 endpoints

Removes the question as deleting it in the survey editor does. If nobody has answered it, it is deleted. If respondents answered it, it is retired instead: it leaves the survey, and it and its answers stay in the results (retired is true, and responses says how many answered). Skip logic that pointed at it is cleaned up and the rest of the page closes up. A question that a page loop takes its items from is refused with a 422 until the loop no longer uses it. A published survey keeps collecting with its published questions until it is published again. Removing a retired question again is a 404; a deleted one no longer exists, so its id answers 403 like any id the token cannot see.

Authorizations

• bearerAuth
  elements:write

Parameters

Path Parameters

id

required

string

Element ID

Header Parameters

Idempotency-Key

string

>= 1 characters <= 128 characters

1 to 128 characters, chosen by the caller. Optional on this operation: a retry with the same key and body replays the first response instead of applying the write twice; the same key with a different body is a 409

Responses

200

Removed

Media typeapplication/json

object

success

boolean

data

object

elementId

string

retired

True when respondents had answered it, so it was retired and its answers kept, not deleted

boolean

responses

How many respondents answered it

integer

meta

Standard response metadata

object

timestamp

Response timestamp in ISO 8601 format

string format: date-time

version

API version

string

requestId

Unique request identifier

string

etag

The resource’s ETag, on a read, create or update of a survey, element, rating or NPS question, distributor or contact. The same value as the ETag response header. Treat it as opaque and send it back as If-Match on the next update.

string

Example

{
  "success": true,
  "meta": {
    "version": "3.0"
  }
}

403

The token or its owner may not edit the survey this element belongs to

Media typeapplication/json

Standard error response format

object

success

boolean

error

object

code

Stable, snake_case domain code – see ApiErrorHandler::EXCEPTION_MAP and DomainException

string

message

Human-readable error message

string

suggestion

Imperative recovery hint for this domain code – see ApiErrorHandler::DOMAIN_CODE_SUGGESTIONS

string

retryable

Whether retrying the identical request might succeed without any change on the caller’s end

boolean

details

Additional, code-specific error details

object

meta

Standard response metadata

object

timestamp

Response timestamp in ISO 8601 format

string format: date-time

version

API version

string

requestId

Unique request identifier

string

etag

The resource’s ETag, on a read, create or update of a survey, element, rating or NPS question, distributor or contact. The same value as the ETag response header. Treat it as opaque and send it back as If-Match on the next update.

string

Example

{
  "success": false,
  "error": {
    "code": "survey_not_found"
  },
  "meta": {
    "version": "3.0"
  }
}

404

The element is a retired question: it has already been removed

Media typeapplication/json

Standard error response format

object

success

boolean

error

object

code

Stable, snake_case domain code – see ApiErrorHandler::EXCEPTION_MAP and DomainException

string

message

Human-readable error message

string

suggestion

Imperative recovery hint for this domain code – see ApiErrorHandler::DOMAIN_CODE_SUGGESTIONS

string

retryable

Whether retrying the identical request might succeed without any change on the caller’s end

boolean

details

Additional, code-specific error details

object

meta

Standard response metadata

object

timestamp

Response timestamp in ISO 8601 format

string format: date-time

version

API version

string

requestId

Unique request identifier

string

etag

The resource’s ETag, on a read, create or update of a survey, element, rating or NPS question, distributor or contact. The same value as the ETag response header. Treat it as opaque and send it back as If-Match on the next update.

string

Example

{
  "success": false,
  "error": {
    "code": "survey_not_found"
  },
  "meta": {
    "version": "3.0"
  }
}

422

A page loop takes its items from this question; change the loop first

Media typeapplication/json

Validation error response with field-specific errors

object

success

boolean

error

object

code

string

message

string

suggestion

string

retryable

boolean

details

Field-specific validation errors

object

key

additional properties

Array<string>

meta

Standard response metadata

object

timestamp

Response timestamp in ISO 8601 format

string format: date-time

version

API version

string

requestId

Unique request identifier

string

etag

The resource’s ETag, on a read, create or update of a survey, element, rating or NPS question, distributor or contact. The same value as the ETag response header. Treat it as opaque and send it back as If-Match on the next update.

string

Example

{
  "success": false,
  "error": {
    "code": "validation_failed",
    "message": "Validation failed",
    "suggestion": "Fix the fields listed in details and re-submit.",
    "retryable": false
  },
  "meta": {
    "version": "3.0"
  }
}