v4

latestOpenAPI 3.0.02026-07-31257282489.4 KB
Engagement Survey

Update a survey

Update an engagement survey. Any pending (not yet sent) deliveries for this engagement are discarded and re-queued from the updated document. While an engagement is live, its audience, targeting and scheduling fields cannot be changed (for fixed frequency engagements neither can its content); pause it first or the request fails with 409. Setting status to live starts delivery. type, project, organisation and createdBy are set server-side and ignored if supplied.

put/engagement/surveys/{surveyId}

Path parameters

surveyIdstring required

Headers

projectstring required

Request body

{"stackTrail":"paths:/engagement/surveys/{surveyId}:put:requestBody:content:application/json:schema","oasType":"schema","type":"unknown"}

Response

Ok

{"stackTrail":"paths:/engagement/surveys/{surveyId}:put:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}