surveys

Submit a survey response for a space

Changed on

Submits or updates the space's response to the active survey for the given slug. Only active admins of the space can submit. Idempotent: repeat submissions overwrite the previous response.

post/v1/spaces/{spaceId}/surveys/{slug}/responses

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

spaceIdstring required
Example:123e4567-e89b-12d3-a456-426614174000

Space UUID to submit a survey response for

slugstring required
Example:onboarding

Request body

selectionsobject required

Map from page id → selected option keys

Example request

{
  "selections": {
    "use_cases": [
      "run_payments",
      "hold_assets"
    ]
  }
}

Response

idnumber required
spaceUuidstring required

Space UUID

surveySlugstring required
surveyVersionnumber required
selectionsobject required
submittedAtstring date-time required
updatedAtstring date-time required
answeredByUserIdnumber nullable required

Changes

  • 20dfb0e32aa4Revision changes
    • breaking

      removed the required property from the response with the status

  • 081e1944f67cRevision changes
    • info

      for the path request parameter spaceId, the type was generalized from number to string

    • info

      response property spaceId deprecated

    • info

      added the required property to the response with the status