Engagement Survey

Create a new survey

Create a new engagement survey. type, project, organisation and createdBy are set server-side and ignored if supplied.

Surveys 2.0: with a definition (SurveyDefinition, schemaVersion 2) the survey is created as a v2 DRAFT: body { name, format?: 'card'|'full', definition, trigger?, frequencyType?, frequency?, frequencyDays?, targetAudience?, conditions? }. The response is the outbound plus warnings (validation issues that block publishing). A malformed definition answers 422 { errors }.

POST

https://api.gleap.io/v3/engagement/surveys

Authorizations

Authorizationstring · headerrequired

Bearer authentication header of the form Bearer <token>.

Headers

projectstringrequired

Bodyapplication/jsonrequired

Response

application/json

Updated November 1, 2026

curl --request POST \
  --url https://api.gleap.io/v3/engagement/surveys \
  --header 'Authorization: Bearer <token>' \
  --header 'project: <project>' \
  --header 'Content-Type: application/json' \
  --data '{}'

No example in the spec.