Create Surveys

📋 Create a Survey

Enables community owners to publish a multi-question survey with optional scheduling and discoverability control.

HTTP Method

POST

Endpoint

/api/v1/surveys

Headers

Name	Type	Required	Description
x-api-key	String	✅ Yes	Secret API key provided by Networked. Required for all API calls.
spaceId	String	❌ No	Required only if the poll is intended for a Space. Otherwise, defaults to Community Feed.

Body Parameters

Name	Type	Required	Description
questions	Array	✅ Yes	List of questions for the survey. Each question has `headText`, `options`, `mandatoryFlag`, and `multipleSelectOptionFlag`.
startTime	Number	✅ Yes	Start time for the survey in Unix timestamp (ms). Can be a future date to schedule it.
endTime	Number	✅ Yes	End time for the survey in Unix timestamp (ms).
communities	Array	✅ Yes	Array of community IDs where the survey will be posted.
hideFromDiscover	Boolean	❌ No	If `true`, hides the survey from being publicly discovered.

Sample Request

{
  "questions": [
    {
      "headText": "Who will win the Asia Cup 2028 ?",
      "options": [
        { "text": "Bangladesh" },
        { "text": "China" },
        { "text": "India" }
      ],
      "mandatoryFlag": true,
      "multipleSelectOptionFlag": true
    },
    {
      "headText": "Who will score more centuries ?",
      "options": [
        { "text": "KL Rahul" },
        { "text": "Rishabh Pant" },
        { "text": "Shubman Gill" }
      ],
      "mandatoryFlag": false,
      "multipleSelectOptionFlag": false
    }
  ],
  "startTime": 1750825559000,
  "endTime": 1751005739000,
  "communities": ["67ce86c3d12a8800120030dd"],
  "hideFromDiscover": true
}

Sample Response

{
  "data": {
    "surveyId": "685b7a9e43e21f0012ecb418",
    "status": 1
  },
  "error": false,
  "message": "Success"
}

Response Interface

Response Field Descriptions

Field	Type	Description
surveyId	String	Unique identifier of the created survey.
status	Number	Status of creation (1 usually indicates success).

Reference

🔗 Response Codes

Notes

The startTime parameter allows scheduling the survey for a future date and time.

multipleSelectOptionFlag lets you allow or restrict multiple answer selection per question.

Always provide a minimum of one question with at least two options.

curl --location 'https://backend.networked.co/api/v1/surveys' \ --header 'x-api-key: <your-api-key>' \ --header 'Content-Type: application/json' \ --data '{ "questions": [ { "headText": "Who will win the Asia Cup 2028 ?", "options": [ { "text": "Bangladesh" }, { "text": "China" }, { "text": "India" } ], "mandatoryFlag": true, "multipleSelectOptionFlag": true }, { "headText": "Who will score more centuries ?", "options": [ { "text": "KL Rahul" }, { "text": "Rishabh Pant" }, { "text": "Shubman Gill" } ], "mandatoryFlag": false, "multipleSelectOptionFlag": false } ], "startTime": 1750825559000, "endTime": 1751005739000, "communities": [ "67959032bc6bea0012fdc671" ], "hideFromDiscover": true }'

📋 Create a Survey#

HTTP Method#

Endpoint#

Headers#

Body Parameters#

Sample Request#

Sample Response#

Response Interface#

Response Field Descriptions#

Reference#

Notes#

Request

Responses