Update Survey

PATCH

/feedback/surveys/{survey_id}

• Production
• QA

Update a survey. Only supplied fields change.

Setting is_active: false stops new sends and in-app impressions while keeping every response already collected.

Authorizations

• BearerAuth

Parameters

Path Parameters

survey_id

required

Survey id (UUID) — from GET /feedback/surveys

string

Survey id (UUID) — from GET /feedback/surveys

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Request Body ^required

object

delivery_channel

Any of:

string

string

/^(email|bridge|in_app)$/

null

null

is_active

Any of:

boolean

boolean

null

null

name

Any of:

string

string

<= 255 characters

null

null

question_text

Any of:

string

string

null

null

template_id

Any of:

integer

integer

null

null

thank_you_copy

Any of:

string

string

null

null

Responses

200

Successful Response

object

data

required

object

comment_mode

Any of:

string

string

null

null

created_at

Any of:

string

string format: date-time

null

null

delivery_channel

required

string

id

required

string

is_active

required

boolean

name

required

string

question_text

required

string

scale_max

required

integer

scale_min

required

integer

score_field_column_id

Any of:

string

string

null

null

template_id

Any of:

integer

integer

null

null

thank_you_copy

Any of:

string

string

null

null

type

required

string

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string