Draft a survey

Workforce module

POST/surveys/draftsurveys.draft

Drafts a pulse survey with its questions. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

Requires the capability knowledge.sop.publish.
OAuth scopes: knowledge.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: SurveyDraftRequest

surveys.draft: SurveyDraftRequest
Field	Type	Required	Description
title	string	Yes	Survey title.Constraints: length 1 to 200
description	string	No	What the survey asks about.Constraints: length 0 to 2000
audience_kind	"Organization" \| "Project" \| "Team" \| "Department" \| "Role" \| "Group"	No	Who the row reaches. Department (a canon department, 1365) is for feed posts only.
project_id	string (uuid)	No	Project audience.
team_id	string (uuid)	No	Team audience.
role_id	string (uuid)	No	Role audience.
group_id	string (uuid)	No	Group audience.
is_anonymous	boolean	No	Anonymous by default.
min_responses	integer	No	Responses before results show; 5 by default.Constraints: range 3 to 1000
closes_at	string (date-time)	No	When responses stop.
questions	array of object	Yes	1 to 50 questions in order.

{
  "title": "Load-in pulse",
  "description": "How did it go?",
  "audience_kind": "Organization",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "team_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "group_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "is_anonymous": true,
  "min_responses": 5,
  "closes_at": "2026-10-08T14:30:00Z",
  "questions": [
    {
      "prompt": "How safe did it feel?",
      "kind": "Scale"
    }
  ]
}

Response 201: Survey

surveys.draft: Survey
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the survey.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Person who created the row; null for seed, platform or system writes.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Person who last updated the row; null for seed, platform or system writes.
title	string	Yes	Survey title.Constraints: length 1 to 200
description	string \| null	Yes	What the survey asks about.Constraints: length 1 to 2000
audience_kind	"Organization" \| "Project" \| "Team" \| "Department" \| "Role" \| "Group"	Yes	Who the row reaches. Department (a canon department, 1365) is for feed posts only.
project_id	string (uuid) \| null	Yes	Identifier of the project audience, or the project the row belongs to.
team_id	string (uuid) \| null	Yes	Identifier of the team audience.
role_id	string (uuid) \| null	Yes	Identifier of the org role audience.
group_id	string (uuid) \| null	Yes	Identifier of the group audience, including department groups.
author_membership_id	string (uuid) \| null	Yes	Identifier of the member who wrote the survey.
is_anonymous	boolean	Yes	Whether answers are stored with no respondent.
min_responses	integer	Yes	Responses needed before results show.Constraints: range 3 to any
survey_state	"Draft" \| "Open" \| "Closed"	Yes	Draft, Open or Closed.
closes_at	string (date-time) \| null	Yes	When responses stop.

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "title": "Load-in pulse",
  "description": "Tell us how the load-in felt.",
  "audience_kind": "Organization",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "team_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "group_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "author_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "is_anonymous": true,
  "min_responses": 5,
  "survey_state": "Draft",
  "closes_at": "2026-10-08T14:30:00Z"
}

Code samples

curl -X POST "$XOS_BASE_URL/surveys/draft" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"title":"Load-in pulse","description":"How did it go?","audience_kind":"Organization","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","team_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","role_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","group_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","is_anonymous":true,"min_responses":5,"closes_at":"2026-10-08T14:30:00Z","questions":[{"prompt":"How safe did it feel?","kind":"Scale"}]}'

const { data } = await xos.surveys.draft({
    "title": "Load-in pulse",
    "description": "How did it go?",
    "audience_kind": "Organization",
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "team_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "group_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "is_anonymous": true,
    "min_responses": 5,
    "closes_at": "2026-10-08T14:30:00Z",
    "questions": [
      {
        "prompt": "How safe did it feel?",
        "kind": "Scale"
      }
    ]
  });

response = xos.surveys.draft({"title": "Load-in pulse", "description": "How did it go?", "audience_kind": "Organization", "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "team_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "group_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "is_anonymous": True, "min_responses": 5, "closes_at": "2026-10-08T14:30:00Z", "questions": [{"prompt": "How safe did it feel?", "kind": "Scale"}]})

xos surveys draft --data '{"title":"Load-in pulse","description":"How did it go?","audience_kind":"Organization","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","team_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","role_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","group_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","is_anonymous":true,"min_responses":5,"closes_at":"2026-10-08T14:30:00Z","questions":[{"prompt":"How safe did it feel?","kind":"Scale"}]}'