Questionnaires

get/v1/questionnairesList questionnaires
post/v1/questionnairesCreate questionnaire
get/v1/questionnaires/{id}Get questionnaire
patch/v1/questionnaires/{id}Update questionnaire
post/v1/questionnaires/{id}/statusSet questionnaire status
get/v1/questionnaires/{id}/linksList questionnaire links
post/v1/questionnaires/{id}/linksCreate questionnaire link
del/v1/questionnaire-links/{id}Revoke questionnaire link
get/v1/questionnaires/{id}/responsesList questionnaire responses
get/v1/questionnaires/{id}/exportExport questionnaire responses
get/v1/questionnaire-responses/{id}Get questionnaire response
post/v1/questionnaire-responses/{id}/applyApply questionnaire response
get/v1/questionnaire-templatesList questionnaire templates
post/v1/questionnaire-templatesCreate questionnaire template
get/v1/questionnaire-templates/{id}Get questionnaire template
patch/v1/questionnaire-templates/{id}Update questionnaire template
post/v1/questionnaire-templates/{id}/archiveArchive questionnaire template

List questionnaires

get/v1/questionnaires

List the workspace's client questionnaires (onboarding forms) with link and response counts, without their question definitions. Archived ones are left out unless includeArchived is true. Requires questionnaires:view.

Query parameters

includeArchivedstring
One oftruefalse

Response 200

Questionnaires

dataarray of QuestionnaireSummaryrequired

Errors

401: Unauthenticated
403: Missing permission, a client-visibility member, or an organization that is not an agency

Request

curl "https://api.posty.social/v1/questionnaires" \
  -H "Authorization: Bearer $POSTY_API_KEY"

Response 200

{
  "data": [
    {
      "id": "string",
      "workspaceId": "string",
      "templateId": "string",
      "templateVersion": 1,
      "name": "string",
      "description": "string",
      "definitionVersion": 1,
      "status": "draft",
      "createdBy": "string",
      "createdAt": "2026-01-15T09:30:00.000Z",
      "updatedAt": "2026-01-15T09:30:00.000Z",
      "sectionCount": 1,
      "questionCount": 1,
      "linkCount": 1,
      "responseCount": 1
    }
  ]
}

Create questionnaire

post/v1/questionnaires

Create a draft questionnaire in the workspace, blank or copied from one of the organization's templates (templateId from list_questionnaire_templates). Counts against the plan's questionnaire limit and needs an agency organization. Requires questionnaires:create.

Request body

templateIdstringnullable
Min length 1
namestring
Min length 1 · Max length 200

Response 201

Questionnaire created

idstringrequired
workspaceIdstringrequired
templateIdstringrequirednullable
templateVersionintegerrequirednullable
namestringrequired
descriptionstringrequirednullable
definitionVersionintegerrequired
statusstringrequired
One ofdraftactivearchived
createdBystringrequirednullable
createdAtstring (date-time)required
updatedAtstring (date-time)required
sectionCountintegerrequired
questionCountintegerrequired
linkCountintegerrequired
responseCountintegerrequired
definitionQuestionnaireDefinitionrequired

Errors

400: Invalid input
401: Unauthenticated
402: The plan's questionnaire limit is reached
403: Missing permission, a client-visibility member, or an organization that is not an agency
404: Not found in this workspace

Request

curl -X POST "https://api.posty.social/v1/questionnaires" \
  -H "Authorization: Bearer $POSTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "templateId": "string",
  "name": "string"
}'

Response 201

{
  "id": "string",
  "workspaceId": "string",
  "templateId": "string",
  "templateVersion": 1,
  "name": "string",
  "description": "string",
  "definitionVersion": 1,
  "status": "draft",
  "createdBy": "string",
  "createdAt": "2026-01-15T09:30:00.000Z",
  "updatedAt": "2026-01-15T09:30:00.000Z",
  "sectionCount": 1,
  "questionCount": 1,
  "linkCount": 1,
  "responseCount": 1,
  "definition": {
    "version": 1,
    "intro": {
      "heading": "string",
      "body": "string"
    },
    "sections": [
      {
        "id": "string",
        "title": "string",
        "description": "string",
        "blocks": [
          {
            "id": null,
            "label": null,
            "helpText": null,
            "required": false,
            "showWhen": null,
            "mapping": null,
            "kind": "short_text",
            "maxLength": 200
          }
        ]
      }
    ],
    "outro": {
      "heading": "string",
      "body": "string"
    }
  }
}

Get questionnaire

get/v1/questionnaires/{id}

Get one questionnaire with its full definition (sections and question blocks), every link sent for it and a summary of each response. Requires questionnaires:view.

Path parameters

idstringrequired
Min length 1

Response 200

Questionnaire

questionnaireQuestionnairerequired
linksarray of QuestionnaireLinkrequired
responsesarray of QuestionnaireResponseSummaryrequired
delegatedConnectAvailablebooleanrequired

Errors

401: Unauthenticated
403: Missing permission, a client-visibility member, or an organization that is not an agency
404: Not found in this workspace

Request

curl "https://api.posty.social/v1/questionnaires/$ID" \
  -H "Authorization: Bearer $POSTY_API_KEY"

Response 200

{
  "questionnaire": {
    "id": "string",
    "workspaceId": "string",
    "templateId": "string",
    "templateVersion": 1,
    "name": "string",
    "description": "string",
    "definitionVersion": 1,
    "status": "draft",
    "createdBy": "string",
    "createdAt": "2026-01-15T09:30:00.000Z",
    "updatedAt": "2026-01-15T09:30:00.000Z",
    "sectionCount": 1,
    "questionCount": 1,
    "linkCount": 1,
    "responseCount": 1,
    "definition": {
      "version": 1,
      "intro": {
        "heading": "string",
        "body": "string"
      },
      "sections": [
        {
          "id": "string",
          "title": "string",
          "description": "string",
          "blocks": [
            null
          ]
        }
      ],
      "outro": {
        "heading": "string",
        "body": "string"
      }
    }
  },
  "links": [
    {
      "id": "string",
      "questionnaireId": "string",
      "workspaceId": "string",
      "recipientEmail": "string",
      "recipientName": "string",
      "note": "string",
      "expiresAt": "2026-01-15T09:30:00.000Z",
      "revokedAt": "2026-01-15T09:30:00.000Z",
      "lastUsedAt": "2026-01-15T09:30:00.000Z",
      "reminderDays": [
        1
      ],
      "lastReminderAt": "2026-01-15T09:30:00.000Z",
      "createdBy": "string",
      "createdAt": "2026-01-15T09:30:00.000Z",
      "definitionVersion": 1,
      "state": "open"
    }
  ],
  "responses": [
    {
      "id": "string",
      "linkId": "string",
      "status": "draft",
      "respondentName": "string",
      "respondentEmail": "string",
      "startedAt": "2026-01-15T09:30:00.000Z",
      "submittedAt": "2026-01-15T09:30:00.000Z",
      "appliedAt": "2026-01-15T09:30:00.000Z"
    }
  ],
  "delegatedConnectAvailable": true
}

Update questionnaire

patch/v1/questionnaires/{id}

Rename a questionnaire, change its description, or replace its whole definition (intro, sections of question blocks, outro). Links already sent keep the form they were sent with. Archived questionnaires cannot be edited. Requires questionnaires:update.

Path parameters

idstringrequired
Min length 1

Request body

namestring
Min length 1 · Max length 200
descriptionstringnullable
Max length 2000
definitionQuestionnaireDefinition

Response 200

Questionnaire updated

idstringrequired
workspaceIdstringrequired
templateIdstringrequirednullable
templateVersionintegerrequirednullable
namestringrequired
descriptionstringrequirednullable
definitionVersionintegerrequired
statusstringrequired
One ofdraftactivearchived
createdBystringrequirednullable
createdAtstring (date-time)required
updatedAtstring (date-time)required
sectionCountintegerrequired
questionCountintegerrequired
linkCountintegerrequired
responseCountintegerrequired
definitionQuestionnaireDefinitionrequired

Errors

400: Invalid input
401: Unauthenticated
403: Missing permission, a client-visibility member, or an organization that is not an agency
404: Not found in this workspace
409: Not allowed in this state

Request

curl -X PATCH "https://api.posty.social/v1/questionnaires/$ID" \
  -H "Authorization: Bearer $POSTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "description": "string",
  "definition": {
    "version": 1,
    "intro": {
      "heading": "string",
      "body": "string"
    },
    "sections": [
      {
        "id": "string",
        "title": "string",
        "description": "string",
        "blocks": [
          {
            "id": null,
            "label": null,
            "helpText": null,
            "required": false,
            "showWhen": null,
            "mapping": null,
            "kind": "short_text",
            "maxLength": 200
          }
        ]
      }
    ],
    "outro": {
      "heading": "string",
      "body": "string"
    }
  }
}'

Response 200

{
  "id": "string",
  "workspaceId": "string",
  "templateId": "string",
  "templateVersion": 1,
  "name": "string",
  "description": "string",
  "definitionVersion": 1,
  "status": "draft",
  "createdBy": "string",
  "createdAt": "2026-01-15T09:30:00.000Z",
  "updatedAt": "2026-01-15T09:30:00.000Z",
  "sectionCount": 1,
  "questionCount": 1,
  "linkCount": 1,
  "responseCount": 1,
  "definition": {
    "version": 1,
    "intro": {
      "heading": "string",
      "body": "string"
    },
    "sections": [
      {
        "id": "string",
        "title": "string",
        "description": "string",
        "blocks": [
          {
            "id": null,
            "label": null,
            "helpText": null,
            "required": false,
            "showWhen": null,
            "mapping": null,
            "kind": "short_text",
            "maxLength": 200
          }
        ]
      }
    ],
    "outro": {
      "heading": "string",
      "body": "string"
    }
  }
}

Set questionnaire status

post/v1/questionnaires/{id}/status

Set a questionnaire to draft, active (it can be sent) or archived. Archiving stops every link already sent for it from opening; restoring an archived one counts against the plan's questionnaire limit again. Requires questionnaires:update.

Path parameters

idstringrequired
Min length 1

Request body

statusstringrequired
One ofdraftactivearchived

Response 200

Questionnaire status set

idstringrequired
workspaceIdstringrequired
templateIdstringrequirednullable
templateVersionintegerrequirednullable
namestringrequired
descriptionstringrequirednullable
definitionVersionintegerrequired
statusstringrequired
One ofdraftactivearchived
createdBystringrequirednullable
createdAtstring (date-time)required
updatedAtstring (date-time)required
sectionCountintegerrequired
questionCountintegerrequired
linkCountintegerrequired
responseCountintegerrequired
definitionQuestionnaireDefinitionrequired

Errors

400: Invalid input
401: Unauthenticated
402: The plan's questionnaire limit is reached
403: Missing permission, a client-visibility member, or an organization that is not an agency
404: Not found in this workspace

Request

curl -X POST "https://api.posty.social/v1/questionnaires/$ID/status" \
  -H "Authorization: Bearer $POSTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "draft"
}'

Response 200

{
  "id": "string",
  "workspaceId": "string",
  "templateId": "string",
  "templateVersion": 1,
  "name": "string",
  "description": "string",
  "definitionVersion": 1,
  "status": "draft",
  "createdBy": "string",
  "createdAt": "2026-01-15T09:30:00.000Z",
  "updatedAt": "2026-01-15T09:30:00.000Z",
  "sectionCount": 1,
  "questionCount": 1,
  "linkCount": 1,
  "responseCount": 1,
  "definition": {
    "version": 1,
    "intro": {
      "heading": "string",
      "body": "string"
    },
    "sections": [
      {
        "id": "string",
        "title": "string",
        "description": "string",
        "blocks": [
          {
            "id": null,
            "label": null,
            "helpText": null,
            "required": false,
            "showWhen": null,
            "mapping": null,
            "kind": "short_text",
            "maxLength": 200
          }
        ]
      }
    ],
    "outro": {
      "heading": "string",
      "body": "string"
    }
  }
}

List questionnaire links

get/v1/questionnaires/{id}/links

List the links sent for a questionnaire, each with its state (open, submitted, revoked or expired). The link URL itself is never returned again after create_questionnaire_link. Requires questionnaires:view.

Path parameters

idstringrequired
Min length 1

Response 200

Links

dataarray of QuestionnaireLinkrequired

Errors

401: Unauthenticated
403: Missing permission, a client-visibility member, or an organization that is not an agency
404: Not found in this workspace

Request

curl "https://api.posty.social/v1/questionnaires/$ID/links" \
  -H "Authorization: Bearer $POSTY_API_KEY"

Response 200

{
  "data": [
    {
      "id": "string",
      "questionnaireId": "string",
      "workspaceId": "string",
      "recipientEmail": "string",
      "recipientName": "string",
      "note": "string",
      "expiresAt": "2026-01-15T09:30:00.000Z",
      "revokedAt": "2026-01-15T09:30:00.000Z",
      "lastUsedAt": "2026-01-15T09:30:00.000Z",
      "reminderDays": [
        1
      ],
      "lastReminderAt": "2026-01-15T09:30:00.000Z",
      "createdBy": "string",
      "createdAt": "2026-01-15T09:30:00.000Z",
      "definitionVersion": 1,
      "state": "open"
    }
  ]
}

Create questionnaire link

post/v1/questionnaires/{id}/links

Create a public link a client opens to fill in an active questionnaire, without an account. The response carries the URL exactly once: share it with the client yourself, because this API sends no email and the URL cannot be fetched again. Requires questionnaires:send.

Path parameters

idstringrequired
Min length 1

Request body

recipientNamestringnullable
Max length 200
notestringnullable
Max length 2000
expiresAtstring (date-time)
Defaults to 30 days from now; capped at 180 days.

Response 201

Link created

idstringrequired
questionnaireIdstringrequired
workspaceIdstringrequired
recipientEmailstringrequirednullable
recipientNamestringrequirednullable
notestringrequirednullable
expiresAtstring (date-time)required
revokedAtstring (date-time)requirednullable
lastUsedAtstring (date-time)requirednullable
reminderDaysarray of integerrequired
Max items 5
lastReminderAtstring (date-time)requirednullable
createdBystringrequirednullable
createdAtstring (date-time)required
definitionVersionintegerrequired
statestringrequired
One ofopensubmittedrevokedexpired
urlstring (uri)required
The public form. Returned only here: Posty stores a hash of the token, so the URL cannot be fetched again.

Errors

400: Invalid input
401: Unauthenticated
403: Missing permission, a client-visibility member, or an organization that is not an agency
404: Not found in this workspace
409: Not allowed in this state

Request

curl -X POST "https://api.posty.social/v1/questionnaires/$ID/links" \
  -H "Authorization: Bearer $POSTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "recipientName": "string",
  "note": "string",
  "expiresAt": "2026-01-15T09:30:00.000Z"
}'

Response 201

{
  "id": "string",
  "questionnaireId": "string",
  "workspaceId": "string",
  "recipientEmail": "string",
  "recipientName": "string",
  "note": "string",
  "expiresAt": "2026-01-15T09:30:00.000Z",
  "revokedAt": "2026-01-15T09:30:00.000Z",
  "lastUsedAt": "2026-01-15T09:30:00.000Z",
  "reminderDays": [
    1
  ],
  "lastReminderAt": "2026-01-15T09:30:00.000Z",
  "createdBy": "string",
  "createdAt": "2026-01-15T09:30:00.000Z",
  "definitionVersion": 1,
  "state": "open",
  "url": "https://example.com"
}

Revoke questionnaire link

del/v1/questionnaire-links/{id}

Revoke a questionnaire link so the client can no longer open it. A response the client already submitted is kept. Requires questionnaires:send.

Path parameters

idstringrequired
Min length 1

Response 204

Link revoked

Errors

401: Unauthenticated
403: Missing permission, a client-visibility member, or an organization that is not an agency
404: Not found in this workspace

Request

curl -X DELETE "https://api.posty.social/v1/questionnaire-links/$ID" \
  -H "Authorization: Bearer $POSTY_API_KEY"

Response 204

No content

List questionnaire responses

get/v1/questionnaires/{id}/responses

List the responses to a questionnaire: who answered, and whether each is a draft in progress, submitted or applied. Read the answers with get_questionnaire_response. Requires questionnaires:view.

Path parameters

idstringrequired
Min length 1

Response 200

Responses

dataarray of QuestionnaireResponseSummaryrequired

Errors

401: Unauthenticated
403: Missing permission, a client-visibility member, or an organization that is not an agency
404: Not found in this workspace

Request

curl "https://api.posty.social/v1/questionnaires/$ID/responses" \
  -H "Authorization: Bearer $POSTY_API_KEY"

Response 200

{
  "data": [
    {
      "id": "string",
      "linkId": "string",
      "status": "draft",
      "respondentName": "string",
      "respondentEmail": "string",
      "startedAt": "2026-01-15T09:30:00.000Z",
      "submittedAt": "2026-01-15T09:30:00.000Z",
      "appliedAt": "2026-01-15T09:30:00.000Z"
    }
  ]
}

Export questionnaire responses

get/v1/questionnaires/{id}/export

Every submitted response to a questionnaire as a table: one column per question, one row per respondent, each answer as text. A question added after a link was sent is an empty cell for that respondent. Requires questionnaires:view.

Path parameters

idstringrequired
Min length 1

Response 200

Responses as rows

columnsarray of objectrequired
Child attributes
- idstringrequired
- labelstringrequired
rowsarray of objectrequired
Child attributes
- respondentNamestringrequirednullable
- respondentEmailstringrequirednullable
- submittedAtstring (date-time)requirednullable
- cellsarray of stringrequired

Errors

401: Unauthenticated
403: Missing permission, a client-visibility member, or an organization that is not an agency
404: Not found in this workspace

Request

curl "https://api.posty.social/v1/questionnaires/$ID/export" \
  -H "Authorization: Bearer $POSTY_API_KEY"

Response 200

{
  "columns": [
    {
      "id": "string",
      "label": "string"
    }
  ],
  "rows": [
    {
      "respondentName": "string",
      "respondentEmail": "string",
      "submittedAt": "2026-01-15T09:30:00.000Z",
      "cells": [
        "string"
      ]
    }
  ]
}

Get questionnaire response

get/v1/questionnaire-responses/{id}

Get one questionnaire response: its answers keyed by question id, the form exactly as it was sent, signed download URLs for uploaded files, the channels the client connected, and what has been applied. Requires questionnaires:view.

Path parameters

idstringrequired
Min length 1

Response 200

Response

responseQuestionnaireResponserequired
mediaarray of objectrequired
Child attributes
- idstringrequired
- urlstringrequirednullable
- titlestringrequired
- contentTypestringrequired
channelsarray of objectrequired
Child attributes
- idstringrequired
- providerstringrequired
  One ofblueskydiscordfacebookinstagramlinkedinpinterestthreadstiktokwordpressyoutube
- namestringrequired
- avatarUrlstringrequirednullable
- connectedHerebooleanrequired

Errors

401: Unauthenticated
403: Missing permission, a client-visibility member, or an organization that is not an agency
404: Not found in this workspace

Request

curl "https://api.posty.social/v1/questionnaire-responses/$ID" \
  -H "Authorization: Bearer $POSTY_API_KEY"

Response 200

{
  "response": {
    "id": "string",
    "linkId": "string",
    "status": "draft",
    "respondentName": "string",
    "respondentEmail": "string",
    "startedAt": "2026-01-15T09:30:00.000Z",
    "submittedAt": "2026-01-15T09:30:00.000Z",
    "appliedAt": "2026-01-15T09:30:00.000Z",
    "questionnaireId": "string",
    "workspaceId": "string",
    "questionnaireName": "string",
    "answers": {
      "key": {
        "kind": "short_text",
        "value": "string"
      }
    },
    "definition": {
      "version": 1,
      "intro": {
        "heading": "string",
        "body": "string"
      },
      "sections": [
        {
          "id": "string",
          "title": "string",
          "description": "string",
          "blocks": [
            null
          ]
        }
      ],
      "outro": {
        "heading": "string",
        "body": "string"
      }
    },
    "appliedBy": "string",
    "appliedTargets": [
      {
        "blockId": "string",
        "target": "string",
        "value": "string",
        "appliedAt": 1
      }
    ],
    "createdAt": "2026-01-15T09:30:00.000Z",
    "updatedAt": "2026-01-15T09:30:00.000Z"
  },
  "media": [
    {
      "id": "string",
      "url": "string",
      "title": "string",
      "contentType": "string"
    }
  ],
  "channels": [
    {
      "id": "string",
      "provider": "bluesky",
      "name": "string",
      "avatarUrl": "string",
      "connectedHere": true
    }
  ]
}

Apply questionnaire response

post/v1/questionnaire-responses/{id}/apply

Write chosen answers of a submitted response into the workspace: only the listed blockIds whose questions carry a mapping. Overwrites the workspace name, logo and brand voice or competitors, and adds personas and objectives; campaign answers come back as campaignPrefill instead of being written. Answers already applied are skipped. Requires questionnaires:update.

Path parameters

idstringrequired
Min length 1

Request body

blockIdsarray of stringrequired
Max items 200

Response 200

Response applied

responseQuestionnaireResponserequired
campaignPrefillobjectrequired
Child attributes
- creativeDirectionstring
- monthlyPostTargetinteger
- objectiveIdsarray of stringrequired
- personaIdsarray of stringrequired

Errors

400: Invalid input
401: Unauthenticated
403: Missing permission, a client-visibility member, or an organization that is not an agency
404: Not found in this workspace
409: Not allowed in this state

Request

curl -X POST "https://api.posty.social/v1/questionnaire-responses/$ID/apply" \
  -H "Authorization: Bearer $POSTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "blockIds": [
    "string"
  ]
}'

Response 200

{
  "response": {
    "id": "string",
    "linkId": "string",
    "status": "draft",
    "respondentName": "string",
    "respondentEmail": "string",
    "startedAt": "2026-01-15T09:30:00.000Z",
    "submittedAt": "2026-01-15T09:30:00.000Z",
    "appliedAt": "2026-01-15T09:30:00.000Z",
    "questionnaireId": "string",
    "workspaceId": "string",
    "questionnaireName": "string",
    "answers": {
      "key": {
        "kind": "short_text",
        "value": "string"
      }
    },
    "definition": {
      "version": 1,
      "intro": {
        "heading": "string",
        "body": "string"
      },
      "sections": [
        {
          "id": "string",
          "title": "string",
          "description": "string",
          "blocks": [
            null
          ]
        }
      ],
      "outro": {
        "heading": "string",
        "body": "string"
      }
    },
    "appliedBy": "string",
    "appliedTargets": [
      {
        "blockId": "string",
        "target": "string",
        "value": "string",
        "appliedAt": 1
      }
    ],
    "createdAt": "2026-01-15T09:30:00.000Z",
    "updatedAt": "2026-01-15T09:30:00.000Z"
  },
  "campaignPrefill": {
    "creativeDirection": "string",
    "monthlyPostTarget": 1,
    "objectiveIds": [
      "string"
    ],
    "personaIds": [
      "string"
    ]
  }
}

List questionnaire templates

get/v1/questionnaire-templates

List the organization's questionnaire templates (without definitions) and the built-in starters a template can be created from. Templates belong to the selected workspace's organization and need a signed-in user (OAuth), not an API key, plus questionnaires:view in the workspace. Requires organization:view.

Query parameters

includeArchivedstring
One oftruefalse

Response 200

Templates

dataarray of QuestionnaireTemplateSummaryrequired
startersarray of objectrequired
Child attributes
- keystringrequired
- namestringrequired
- descriptionstringrequired
- sectionCountintegerrequired

Errors

401: Unauthenticated
403: Missing permission, a client-visibility member, or an organization that is not an agency
404: Not found in this workspace

Request

curl "https://api.posty.social/v1/questionnaire-templates" \
  -H "Authorization: Bearer $POSTY_API_KEY"

Response 200

{
  "data": [
    {
      "id": "string",
      "organizationId": "string",
      "name": "string",
      "description": "string",
      "definitionVersion": 1,
      "starterKey": "string",
      "archived": true,
      "archivedAt": "2026-01-15T09:30:00.000Z",
      "createdBy": "string",
      "createdAt": "2026-01-15T09:30:00.000Z",
      "updatedAt": "2026-01-15T09:30:00.000Z",
      "sectionCount": 1,
      "questionCount": 1
    }
  ],
  "starters": [
    {
      "key": "string",
      "name": "string",
      "description": "string",
      "sectionCount": 1
    }
  ]
}

Create questionnaire template

post/v1/questionnaire-templates

Create an organization questionnaire template, blank, from a starterKey listed by list_questionnaire_templates, or from a full definition. Templates belong to the selected workspace's organization and need a signed-in user (OAuth), not an API key, plus questionnaires:view in the workspace. Requires organization:manage_templates (organization owners and admins).

Request body

namestring
Min length 1 · Max length 200
descriptionstringnullable
Max length 2000
definitionQuestionnaireDefinition
starterKeystring
Max length 100

Response 201

Template created

idstringrequired
organizationIdstringrequired
namestringrequired
descriptionstringrequirednullable
definitionVersionintegerrequired
starterKeystringrequirednullable
archivedbooleanrequired
archivedAtstring (date-time)requirednullable
createdBystringrequirednullable
createdAtstring (date-time)required
updatedAtstring (date-time)required
sectionCountintegerrequired
questionCountintegerrequired
definitionQuestionnaireDefinitionrequired

Errors

400: Invalid input
401: Unauthenticated
403: Missing permission, a client-visibility member, or an organization that is not an agency
404: Not found in this workspace

Request

curl -X POST "https://api.posty.social/v1/questionnaire-templates" \
  -H "Authorization: Bearer $POSTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "description": "string",
  "definition": {
    "version": 1,
    "intro": {
      "heading": "string",
      "body": "string"
    },
    "sections": [
      {
        "id": "string",
        "title": "string",
        "description": "string",
        "blocks": [
          {
            "id": null,
            "label": null,
            "helpText": null,
            "required": false,
            "showWhen": null,
            "mapping": null,
            "kind": "short_text",
            "maxLength": 200
          }
        ]
      }
    ],
    "outro": {
      "heading": "string",
      "body": "string"
    }
  },
  "starterKey": "string"
}'

Response 201

{
  "id": "string",
  "organizationId": "string",
  "name": "string",
  "description": "string",
  "definitionVersion": 1,
  "starterKey": "string",
  "archived": true,
  "archivedAt": "2026-01-15T09:30:00.000Z",
  "createdBy": "string",
  "createdAt": "2026-01-15T09:30:00.000Z",
  "updatedAt": "2026-01-15T09:30:00.000Z",
  "sectionCount": 1,
  "questionCount": 1,
  "definition": {
    "version": 1,
    "intro": {
      "heading": "string",
      "body": "string"
    },
    "sections": [
      {
        "id": "string",
        "title": "string",
        "description": "string",
        "blocks": [
          {
            "id": null,
            "label": null,
            "helpText": null,
            "required": false,
            "showWhen": null,
            "mapping": null,
            "kind": "short_text",
            "maxLength": 200
          }
        ]
      }
    ],
    "outro": {
      "heading": "string",
      "body": "string"
    }
  }
}

Get questionnaire template

get/v1/questionnaire-templates/{id}

Get one questionnaire template with its full definition. Templates belong to the selected workspace's organization and need a signed-in user (OAuth), not an API key, plus questionnaires:view in the workspace. Requires organization:view.

Path parameters

idstringrequired
Min length 1

Response 200

Template

idstringrequired
organizationIdstringrequired
namestringrequired
descriptionstringrequirednullable
definitionVersionintegerrequired
starterKeystringrequirednullable
archivedbooleanrequired
archivedAtstring (date-time)requirednullable
createdBystringrequirednullable
createdAtstring (date-time)required
updatedAtstring (date-time)required
sectionCountintegerrequired
questionCountintegerrequired
definitionQuestionnaireDefinitionrequired

Errors

401: Unauthenticated
403: Missing permission, a client-visibility member, or an organization that is not an agency
404: Not found in this workspace

Request

curl "https://api.posty.social/v1/questionnaire-templates/$ID" \
  -H "Authorization: Bearer $POSTY_API_KEY"

Response 200

{
  "id": "string",
  "organizationId": "string",
  "name": "string",
  "description": "string",
  "definitionVersion": 1,
  "starterKey": "string",
  "archived": true,
  "archivedAt": "2026-01-15T09:30:00.000Z",
  "createdBy": "string",
  "createdAt": "2026-01-15T09:30:00.000Z",
  "updatedAt": "2026-01-15T09:30:00.000Z",
  "sectionCount": 1,
  "questionCount": 1,
  "definition": {
    "version": 1,
    "intro": {
      "heading": "string",
      "body": "string"
    },
    "sections": [
      {
        "id": "string",
        "title": "string",
        "description": "string",
        "blocks": [
          {
            "id": null,
            "label": null,
            "helpText": null,
            "required": false,
            "showWhen": null,
            "mapping": null,
            "kind": "short_text",
            "maxLength": 200
          }
        ]
      }
    ],
    "outro": {
      "heading": "string",
      "body": "string"
    }
  }
}

Update questionnaire template

patch/v1/questionnaire-templates/{id}

Rename a questionnaire template, change its description or replace its definition. Questionnaires already copied from it do not change. Templates belong to the selected workspace's organization and need a signed-in user (OAuth), not an API key, plus questionnaires:view in the workspace. Requires organization:manage_templates.

Path parameters

idstringrequired
Min length 1

Request body

namestring
Min length 1 · Max length 200
descriptionstringnullable
Max length 2000
definitionQuestionnaireDefinition

Response 200

Template updated

idstringrequired
organizationIdstringrequired
namestringrequired
descriptionstringrequirednullable
definitionVersionintegerrequired
starterKeystringrequirednullable
archivedbooleanrequired
archivedAtstring (date-time)requirednullable
createdBystringrequirednullable
createdAtstring (date-time)required
updatedAtstring (date-time)required
sectionCountintegerrequired
questionCountintegerrequired
definitionQuestionnaireDefinitionrequired

Errors

400: Invalid input
401: Unauthenticated
403: Missing permission, a client-visibility member, or an organization that is not an agency
404: Not found in this workspace

Request

curl -X PATCH "https://api.posty.social/v1/questionnaire-templates/$ID" \
  -H "Authorization: Bearer $POSTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "description": "string",
  "definition": {
    "version": 1,
    "intro": {
      "heading": "string",
      "body": "string"
    },
    "sections": [
      {
        "id": "string",
        "title": "string",
        "description": "string",
        "blocks": [
          {
            "id": null,
            "label": null,
            "helpText": null,
            "required": false,
            "showWhen": null,
            "mapping": null,
            "kind": "short_text",
            "maxLength": 200
          }
        ]
      }
    ],
    "outro": {
      "heading": "string",
      "body": "string"
    }
  }
}'

Response 200

{
  "id": "string",
  "organizationId": "string",
  "name": "string",
  "description": "string",
  "definitionVersion": 1,
  "starterKey": "string",
  "archived": true,
  "archivedAt": "2026-01-15T09:30:00.000Z",
  "createdBy": "string",
  "createdAt": "2026-01-15T09:30:00.000Z",
  "updatedAt": "2026-01-15T09:30:00.000Z",
  "sectionCount": 1,
  "questionCount": 1,
  "definition": {
    "version": 1,
    "intro": {
      "heading": "string",
      "body": "string"
    },
    "sections": [
      {
        "id": "string",
        "title": "string",
        "description": "string",
        "blocks": [
          {
            "id": null,
            "label": null,
            "helpText": null,
            "required": false,
            "showWhen": null,
            "mapping": null,
            "kind": "short_text",
            "maxLength": 200
          }
        ]
      }
    ],
    "outro": {
      "heading": "string",
      "body": "string"
    }
  }
}

Archive questionnaire template

post/v1/questionnaire-templates/{id}/archive

Archive a questionnaire template so it is no longer offered. Questionnaires already copied from it keep working. Templates belong to the selected workspace's organization and need a signed-in user (OAuth), not an API key, plus questionnaires:view in the workspace. Requires organization:manage_templates.

Path parameters

idstringrequired
Min length 1

Response 200

Template archived

idstringrequired
organizationIdstringrequired
namestringrequired
descriptionstringrequirednullable
definitionVersionintegerrequired
starterKeystringrequirednullable
archivedbooleanrequired
archivedAtstring (date-time)requirednullable
createdBystringrequirednullable
createdAtstring (date-time)required
updatedAtstring (date-time)required
sectionCountintegerrequired
questionCountintegerrequired
definitionQuestionnaireDefinitionrequired

Errors

401: Unauthenticated
403: Missing permission, a client-visibility member, or an organization that is not an agency
404: Not found in this workspace

Request

curl -X POST "https://api.posty.social/v1/questionnaire-templates/$ID/archive" \
  -H "Authorization: Bearer $POSTY_API_KEY"

Response 200

{
  "id": "string",
  "organizationId": "string",
  "name": "string",
  "description": "string",
  "definitionVersion": 1,
  "starterKey": "string",
  "archived": true,
  "archivedAt": "2026-01-15T09:30:00.000Z",
  "createdBy": "string",
  "createdAt": "2026-01-15T09:30:00.000Z",
  "updatedAt": "2026-01-15T09:30:00.000Z",
  "sectionCount": 1,
  "questionCount": 1,
  "definition": {
    "version": 1,
    "intro": {
      "heading": "string",
      "body": "string"
    },
    "sections": [
      {
        "id": "string",
        "title": "string",
        "description": "string",
        "blocks": [
          {
            "id": null,
            "label": null,
            "helpText": null,
            "required": false,
            "showWhen": null,
            "mapping": null,
            "kind": "short_text",
            "maxLength": 200
          }
        ]
      }
    ],
    "outro": {
      "heading": "string",
      "body": "string"
    }
  }
}

Models

Objects referenced by the endpoints above.

Questionnaire

idstringrequired
workspaceIdstringrequired
templateIdstringrequirednullable
templateVersionintegerrequirednullable
namestringrequired
descriptionstringrequirednullable
definitionVersionintegerrequired
statusstringrequired
One ofdraftactivearchived
createdBystringrequirednullable
createdAtstring (date-time)required
updatedAtstring (date-time)required
sectionCountintegerrequired
questionCountintegerrequired
linkCountintegerrequired
responseCountintegerrequired
definitionQuestionnaireDefinitionrequired

QuestionnaireDefinition

versionnumberrequired
One of1
introobjectrequired
Child attributes
- headingstringrequired
  Min length 1 · Max length 300
- bodystring
  Max length 2000
sectionsarray of objectrequired
Min items 1 · Max items 20
Child attributes
- idstringrequired
  Min length 1 · Max length 40
- titlestringrequired
  Min length 1 · Max length 300
- descriptionstring
  Max length 2000
- blocksarray of object or object or object or object or object or object or object or object or object or object or object or object or object or object or object or objectrequired
  Max items 50
  Option 1
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  helpTextstring
  Max length 2000
  requiredboolean
  Default false
  showWhenobject
  Child attributes
  blockIdstringrequired
  Min length 1 · Max length 40
  opstringrequired
  One ofequalsnot_equalsincludesis_answered
  valuestring
  Max length 300
  mappingobject or object or object or object or object or object or object or object
  Option 1
  targetstringrequired
  One ofworkspace.name
  Option 2
  targetstringrequired
  One ofworkspace.logo
  Option 3
  targetstringrequired
  One ofbrand.voice
  Option 4
  targetstringrequired
  One ofbrand.competitors
  Option 5
  targetstringrequired
  One ofpersona
  Option 6
  targetstringrequired
  One ofobjective
  metricKeystring
  Max length 100
  Option 7
  targetstringrequired
  One ofcampaign.creativeDirection
  Option 8
  targetstringrequired
  One ofcampaign.monthlyPostTarget
  kindstringrequired
  One ofshort_text
  maxLengthinteger
  Default 200 · Min 1 · Max 500
  Option 2
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  helpTextstring
  Max length 2000
  requiredboolean
  Default false
  showWhenobject
  Child attributes
  blockIdstringrequired
  Min length 1 · Max length 40
  opstringrequired
  One ofequalsnot_equalsincludesis_answered
  valuestring
  Max length 300
  mappingobject or object or object or object or object or object or object or object
  Option 1
  targetstringrequired
  One ofworkspace.name
  Option 2
  targetstringrequired
  One ofworkspace.logo
  Option 3
  targetstringrequired
  One ofbrand.voice
  Option 4
  targetstringrequired
  One ofbrand.competitors
  Option 5
  targetstringrequired
  One ofpersona
  Option 6
  targetstringrequired
  One ofobjective
  metricKeystring
  Max length 100
  Option 7
  targetstringrequired
  One ofcampaign.creativeDirection
  Option 8
  targetstringrequired
  One ofcampaign.monthlyPostTarget
  kindstringrequired
  One oflong_text
  maxLengthinteger
  Default 5000 · Min 1 · Max 10000
  Option 3
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  helpTextstring
  Max length 2000
  requiredboolean
  Default false
  showWhenobject
  Child attributes
  blockIdstringrequired
  Min length 1 · Max length 40
  opstringrequired
  One ofequalsnot_equalsincludesis_answered
  valuestring
  Max length 300
  mappingobject or object or object or object or object or object or object or object
  Option 1
  targetstringrequired
  One ofworkspace.name
  Option 2
  targetstringrequired
  One ofworkspace.logo
  Option 3
  targetstringrequired
  One ofbrand.voice
  Option 4
  targetstringrequired
  One ofbrand.competitors
  Option 5
  targetstringrequired
  One ofpersona
  Option 6
  targetstringrequired
  One ofobjective
  metricKeystring
  Max length 100
  Option 7
  targetstringrequired
  One ofcampaign.creativeDirection
  Option 8
  targetstringrequired
  One ofcampaign.monthlyPostTarget
  kindstringrequired
  One ofemail
  Option 4
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  helpTextstring
  Max length 2000
  requiredboolean
  Default false
  showWhenobject
  Child attributes
  blockIdstringrequired
  Min length 1 · Max length 40
  opstringrequired
  One ofequalsnot_equalsincludesis_answered
  valuestring
  Max length 300
  mappingobject or object or object or object or object or object or object or object
  Option 1
  targetstringrequired
  One ofworkspace.name
  Option 2
  targetstringrequired
  One ofworkspace.logo
  Option 3
  targetstringrequired
  One ofbrand.voice
  Option 4
  targetstringrequired
  One ofbrand.competitors
  Option 5
  targetstringrequired
  One ofpersona
  Option 6
  targetstringrequired
  One ofobjective
  metricKeystring
  Max length 100
  Option 7
  targetstringrequired
  One ofcampaign.creativeDirection
  Option 8
  targetstringrequired
  One ofcampaign.monthlyPostTarget
  kindstringrequired
  One ofurl
  Option 5
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  helpTextstring
  Max length 2000
  requiredboolean
  Default false
  showWhenobject
  Child attributes
  blockIdstringrequired
  Min length 1 · Max length 40
  opstringrequired
  One ofequalsnot_equalsincludesis_answered
  valuestring
  Max length 300
  mappingobject or object or object or object or object or object or object or object
  Option 1
  targetstringrequired
  One ofworkspace.name
  Option 2
  targetstringrequired
  One ofworkspace.logo
  Option 3
  targetstringrequired
  One ofbrand.voice
  Option 4
  targetstringrequired
  One ofbrand.competitors
  Option 5
  targetstringrequired
  One ofpersona
  Option 6
  targetstringrequired
  One ofobjective
  metricKeystring
  Max length 100
  Option 7
  targetstringrequired
  One ofcampaign.creativeDirection
  Option 8
  targetstringrequired
  One ofcampaign.monthlyPostTarget
  kindstringrequired
  One ofurl_list
  maxItemsinteger
  Default 10 · Min 1 · Max 50
  Option 6
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  helpTextstring
  Max length 2000
  requiredboolean
  Default false
  showWhenobject
  Child attributes
  blockIdstringrequired
  Min length 1 · Max length 40
  opstringrequired
  One ofequalsnot_equalsincludesis_answered
  valuestring
  Max length 300
  mappingobject or object or object or object or object or object or object or object
  Option 1
  targetstringrequired
  One ofworkspace.name
  Option 2
  targetstringrequired
  One ofworkspace.logo
  Option 3
  targetstringrequired
  One ofbrand.voice
  Option 4
  targetstringrequired
  One ofbrand.competitors
  Option 5
  targetstringrequired
  One ofpersona
  Option 6
  targetstringrequired
  One ofobjective
  metricKeystring
  Max length 100
  Option 7
  targetstringrequired
  One ofcampaign.creativeDirection
  Option 8
  targetstringrequired
  One ofcampaign.monthlyPostTarget
  kindstringrequired
  One ofnumber
  minnumber
  maxnumber
  Option 7
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  helpTextstring
  Max length 2000
  requiredboolean
  Default false
  showWhenobject
  Child attributes
  blockIdstringrequired
  Min length 1 · Max length 40
  opstringrequired
  One ofequalsnot_equalsincludesis_answered
  valuestring
  Max length 300
  mappingobject or object or object or object or object or object or object or object
  Option 1
  targetstringrequired
  One ofworkspace.name
  Option 2
  targetstringrequired
  One ofworkspace.logo
  Option 3
  targetstringrequired
  One ofbrand.voice
  Option 4
  targetstringrequired
  One ofbrand.competitors
  Option 5
  targetstringrequired
  One ofpersona
  Option 6
  targetstringrequired
  One ofobjective
  metricKeystring
  Max length 100
  Option 7
  targetstringrequired
  One ofcampaign.creativeDirection
  Option 8
  targetstringrequired
  One ofcampaign.monthlyPostTarget
  kindstringrequired
  One ofdate
  Option 8
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  helpTextstring
  Max length 2000
  requiredboolean
  Default false
  showWhenobject
  Child attributes
  blockIdstringrequired
  Min length 1 · Max length 40
  opstringrequired
  One ofequalsnot_equalsincludesis_answered
  valuestring
  Max length 300
  mappingobject or object or object or object or object or object or object or object
  Option 1
  targetstringrequired
  One ofworkspace.name
  Option 2
  targetstringrequired
  One ofworkspace.logo
  Option 3
  targetstringrequired
  One ofbrand.voice
  Option 4
  targetstringrequired
  One ofbrand.competitors
  Option 5
  targetstringrequired
  One ofpersona
  Option 6
  targetstringrequired
  One ofobjective
  metricKeystring
  Max length 100
  Option 7
  targetstringrequired
  One ofcampaign.creativeDirection
  Option 8
  targetstringrequired
  One ofcampaign.monthlyPostTarget
  kindstringrequired
  One ofsingle_choice
  optionsarray of objectrequired
  Min items 2 · Max items 50
  Child attributes
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  allowOtherboolean
  Default false
  Option 9
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  helpTextstring
  Max length 2000
  requiredboolean
  Default false
  showWhenobject
  Child attributes
  blockIdstringrequired
  Min length 1 · Max length 40
  opstringrequired
  One ofequalsnot_equalsincludesis_answered
  valuestring
  Max length 300
  mappingobject or object or object or object or object or object or object or object
  Option 1
  targetstringrequired
  One ofworkspace.name
  Option 2
  targetstringrequired
  One ofworkspace.logo
  Option 3
  targetstringrequired
  One ofbrand.voice
  Option 4
  targetstringrequired
  One ofbrand.competitors
  Option 5
  targetstringrequired
  One ofpersona
  Option 6
  targetstringrequired
  One ofobjective
  metricKeystring
  Max length 100
  Option 7
  targetstringrequired
  One ofcampaign.creativeDirection
  Option 8
  targetstringrequired
  One ofcampaign.monthlyPostTarget
  kindstringrequired
  One ofmulti_choice
  optionsarray of objectrequired
  Min items 2 · Max items 50
  Child attributes
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  allowOtherboolean
  Default false
  Option 10
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  helpTextstring
  Max length 2000
  requiredboolean
  Default false
  showWhenobject
  Child attributes
  blockIdstringrequired
  Min length 1 · Max length 40
  opstringrequired
  One ofequalsnot_equalsincludesis_answered
  valuestring
  Max length 300
  mappingobject or object or object or object or object or object or object or object
  Option 1
  targetstringrequired
  One ofworkspace.name
  Option 2
  targetstringrequired
  One ofworkspace.logo
  Option 3
  targetstringrequired
  One ofbrand.voice
  Option 4
  targetstringrequired
  One ofbrand.competitors
  Option 5
  targetstringrequired
  One ofpersona
  Option 6
  targetstringrequired
  One ofobjective
  metricKeystring
  Max length 100
  Option 7
  targetstringrequired
  One ofcampaign.creativeDirection
  Option 8
  targetstringrequired
  One ofcampaign.monthlyPostTarget
  kindstringrequired
  One ofdropdown
  optionsarray of objectrequired
  Min items 2 · Max items 50
  Child attributes
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  Option 11
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  helpTextstring
  Max length 2000
  requiredboolean
  Default false
  showWhenobject
  Child attributes
  blockIdstringrequired
  Min length 1 · Max length 40
  opstringrequired
  One ofequalsnot_equalsincludesis_answered
  valuestring
  Max length 300
  mappingobject or object or object or object or object or object or object or object
  Option 1
  targetstringrequired
  One ofworkspace.name
  Option 2
  targetstringrequired
  One ofworkspace.logo
  Option 3
  targetstringrequired
  One ofbrand.voice
  Option 4
  targetstringrequired
  One ofbrand.competitors
  Option 5
  targetstringrequired
  One ofpersona
  Option 6
  targetstringrequired
  One ofobjective
  metricKeystring
  Max length 100
  Option 7
  targetstringrequired
  One ofcampaign.creativeDirection
  Option 8
  targetstringrequired
  One ofcampaign.monthlyPostTarget
  kindstringrequired
  One ofyes_no
  Option 12
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  helpTextstring
  Max length 2000
  requiredboolean
  Default false
  showWhenobject
  Child attributes
  blockIdstringrequired
  Min length 1 · Max length 40
  opstringrequired
  One ofequalsnot_equalsincludesis_answered
  valuestring
  Max length 300
  mappingobject or object or object or object or object or object or object or object
  Option 1
  targetstringrequired
  One ofworkspace.name
  Option 2
  targetstringrequired
  One ofworkspace.logo
  Option 3
  targetstringrequired
  One ofbrand.voice
  Option 4
  targetstringrequired
  One ofbrand.competitors
  Option 5
  targetstringrequired
  One ofpersona
  Option 6
  targetstringrequired
  One ofobjective
  metricKeystring
  Max length 100
  Option 7
  targetstringrequired
  One ofcampaign.creativeDirection
  Option 8
  targetstringrequired
  One ofcampaign.monthlyPostTarget
  kindstringrequired
  One ofscale
  mininteger
  Default 1
  maxinteger
  Default 5
  minLabelstring
  Max length 60
  maxLabelstring
  Max length 60
  Option 13
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  helpTextstring
  Max length 2000
  requiredboolean
  Default false
  showWhenobject
  Child attributes
  blockIdstringrequired
  Min length 1 · Max length 40
  opstringrequired
  One ofequalsnot_equalsincludesis_answered
  valuestring
  Max length 300
  mappingobject or object or object or object or object or object or object or object
  Option 1
  targetstringrequired
  One ofworkspace.name
  Option 2
  targetstringrequired
  One ofworkspace.logo
  Option 3
  targetstringrequired
  One ofbrand.voice
  Option 4
  targetstringrequired
  One ofbrand.competitors
  Option 5
  targetstringrequired
  One ofpersona
  Option 6
  targetstringrequired
  One ofobjective
  metricKeystring
  Max length 100
  Option 7
  targetstringrequired
  One ofcampaign.creativeDirection
  Option 8
  targetstringrequired
  One ofcampaign.monthlyPostTarget
  kindstringrequired
  One ofcolor_list
  maxItemsinteger
  Default 6 · Min 1 · Max 12
  Option 14
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  helpTextstring
  Max length 2000
  requiredboolean
  Default false
  showWhenobject
  Child attributes
  blockIdstringrequired
  Min length 1 · Max length 40
  opstringrequired
  One ofequalsnot_equalsincludesis_answered
  valuestring
  Max length 300
  mappingobject or object or object or object or object or object or object or object
  Option 1
  targetstringrequired
  One ofworkspace.name
  Option 2
  targetstringrequired
  One ofworkspace.logo
  Option 3
  targetstringrequired
  One ofbrand.voice
  Option 4
  targetstringrequired
  One ofbrand.competitors
  Option 5
  targetstringrequired
  One ofpersona
  Option 6
  targetstringrequired
  One ofobjective
  metricKeystring
  Max length 100
  Option 7
  targetstringrequired
  One ofcampaign.creativeDirection
  Option 8
  targetstringrequired
  One ofcampaign.monthlyPostTarget
  kindstringrequired
  One offile_upload
  acceptarray of stringrequired
  Min items 1 · Max items 20
  maxFilesinteger
  Default 5 · Min 1 · Max 20
  Option 15
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  helpTextstring
  Max length 2000
  requiredboolean
  Default false
  showWhenobject
  Child attributes
  blockIdstringrequired
  Min length 1 · Max length 40
  opstringrequired
  One ofequalsnot_equalsincludesis_answered
  valuestring
  Max length 300
  mappingobject or object or object or object or object or object or object or object
  Option 1
  targetstringrequired
  One ofworkspace.name
  Option 2
  targetstringrequired
  One ofworkspace.logo
  Option 3
  targetstringrequired
  One ofbrand.voice
  Option 4
  targetstringrequired
  One ofbrand.competitors
  Option 5
  targetstringrequired
  One ofpersona
  Option 6
  targetstringrequired
  One ofobjective
  metricKeystring
  Max length 100
  Option 7
  targetstringrequired
  One ofcampaign.creativeDirection
  Option 8
  targetstringrequired
  One ofcampaign.monthlyPostTarget
  kindstringrequired
  One ofstatement
  bodystringrequired
  Max length 2000
  confirmLabelstring
  Max length 300
  Option 16
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  helpTextstring
  Max length 2000
  requiredboolean
  Default false
  showWhenobject
  Child attributes
  blockIdstringrequired
  Min length 1 · Max length 40
  opstringrequired
  One ofequalsnot_equalsincludesis_answered
  valuestring
  Max length 300
  mappingobject or object or object or object or object or object or object or object
  Option 1
  targetstringrequired
  One ofworkspace.name
  Option 2
  targetstringrequired
  One ofworkspace.logo
  Option 3
  targetstringrequired
  One ofbrand.voice
  Option 4
  targetstringrequired
  One ofbrand.competitors
  Option 5
  targetstringrequired
  One ofpersona
  Option 6
  targetstringrequired
  One ofobjective
  metricKeystring
  Max length 100
  Option 7
  targetstringrequired
  One ofcampaign.creativeDirection
  Option 8
  targetstringrequired
  One ofcampaign.monthlyPostTarget
  kindstringrequired
  One ofconnect_channels
  platformsarray of stringrequired
  One ofblueskydiscordfacebookinstagramlinkedinpinterestthreadstiktokwordpressyoutube
  Min items 1
  minimuminteger
  Default 0 · Min 0
outroobjectrequired
Child attributes
- headingstringrequired
  Min length 1 · Max length 300
- bodystring
  Max length 2000

QuestionnaireLink

idstringrequired
questionnaireIdstringrequired
workspaceIdstringrequired
recipientEmailstringrequirednullable
recipientNamestringrequirednullable
notestringrequirednullable
expiresAtstring (date-time)required
revokedAtstring (date-time)requirednullable
lastUsedAtstring (date-time)requirednullable
reminderDaysarray of integerrequired
Max items 5
lastReminderAtstring (date-time)requirednullable
createdBystringrequirednullable
createdAtstring (date-time)required
definitionVersionintegerrequired
statestringrequired
One ofopensubmittedrevokedexpired

QuestionnaireResponse

idstringrequired
linkIdstringrequired
statusstringrequired
One ofdraftsubmittedapplied
respondentNamestringrequirednullable
respondentEmailstringrequirednullable
startedAtstring (date-time)required
submittedAtstring (date-time)requirednullable
appliedAtstring (date-time)requirednullable
questionnaireIdstringrequired
workspaceIdstringrequired
questionnaireNamestringrequired
answersmap of object or object or object or object or object or object or object or object or object or object or object or object or object or object or object or objectrequired
Option 1
- kindstringrequired
  One ofshort_text
- valuestringrequired
Option 2
- kindstringrequired
  One oflong_text
- valuestringrequired
Option 3
- kindstringrequired
  One ofemail
- valuestringrequired
Option 4
- kindstringrequired
  One ofurl
- valuestringrequired
Option 5
- kindstringrequired
  One ofurl_list
- valuesarray of stringrequired
Option 6
- kindstringrequired
  One ofnumber
- valuenumberrequired
Option 7
- kindstringrequired
  One ofdate
- valuestringrequired
Option 8
- kindstringrequired
  One ofsingle_choice
- optionIdstringrequirednullable
- otherstring
Option 9
- kindstringrequired
  One ofmulti_choice
- optionIdsarray of stringrequired
- otherstring
Option 10
- kindstringrequired
  One ofdropdown
- optionIdstringrequired
Option 11
- kindstringrequired
  One ofyes_no
- valuebooleanrequired
Option 12
- kindstringrequired
  One ofscale
- valueintegerrequired
Option 13
- kindstringrequired
  One ofcolor_list
- valuesarray of stringrequired
Option 14
- kindstringrequired
  One offile_upload
- mediaIdsarray of stringrequired
Option 15
- kindstringrequired
  One ofstatement
- confirmedbooleanrequired
Option 16
- kindstringrequired
  One ofconnect_channels
- channelIdsarray of stringrequired
definitionanyrequired
Child attributes
- versionnumberrequired
  One of1
- introobjectrequired
  Child attributes
  headingstringrequired
  Min length 1 · Max length 300
  bodystring
  Max length 2000
- sectionsarray of objectrequired
  Min items 1 · Max items 20
  Child attributes
  idstringrequired
  Min length 1 · Max length 40
  titlestringrequired
  Min length 1 · Max length 300
  descriptionstring
  Max length 2000
  blocksarray of object or object or object or object or object or object or object or object or object or object or object or object or object or object or object or objectrequired
  Max items 50
  Option 1
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  helpTextstring
  Max length 2000
  requiredboolean
  Default false
  showWhenobject
  Child attributes
  blockIdstringrequired
  Min length 1 · Max length 40
  opstringrequired
  One ofequalsnot_equalsincludesis_answered
  valuestring
  Max length 300
  mappingobject or object or object or object or object or object or object or object
  Option 1
  targetstringrequired
  One ofworkspace.name
  Option 2
  targetstringrequired
  One ofworkspace.logo
  Option 3
  targetstringrequired
  One ofbrand.voice
  Option 4
  targetstringrequired
  One ofbrand.competitors
  Option 5
  targetstringrequired
  One ofpersona
  Option 6
  targetstringrequired
  One ofobjective
  metricKeystring
  Max length 100
  Option 7
  targetstringrequired
  One ofcampaign.creativeDirection
  Option 8
  targetstringrequired
  One ofcampaign.monthlyPostTarget
  kindstringrequired
  One ofshort_text
  maxLengthinteger
  Default 200 · Min 1 · Max 500
  Option 2
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  helpTextstring
  Max length 2000
  requiredboolean
  Default false
  showWhenobject
  Child attributes
  blockIdstringrequired
  Min length 1 · Max length 40
  opstringrequired
  One ofequalsnot_equalsincludesis_answered
  valuestring
  Max length 300
  mappingobject or object or object or object or object or object or object or object
  Option 1
  targetstringrequired
  One ofworkspace.name
  Option 2
  targetstringrequired
  One ofworkspace.logo
  Option 3
  targetstringrequired
  One ofbrand.voice
  Option 4
  targetstringrequired
  One ofbrand.competitors
  Option 5
  targetstringrequired
  One ofpersona
  Option 6
  targetstringrequired
  One ofobjective
  metricKeystring
  Max length 100
  Option 7
  targetstringrequired
  One ofcampaign.creativeDirection
  Option 8
  targetstringrequired
  One ofcampaign.monthlyPostTarget
  kindstringrequired
  One oflong_text
  maxLengthinteger
  Default 5000 · Min 1 · Max 10000
  Option 3
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  helpTextstring
  Max length 2000
  requiredboolean
  Default false
  showWhenobject
  Child attributes
  blockIdstringrequired
  Min length 1 · Max length 40
  opstringrequired
  One ofequalsnot_equalsincludesis_answered
  valuestring
  Max length 300
  mappingobject or object or object or object or object or object or object or object
  Option 1
  targetstringrequired
  One ofworkspace.name
  Option 2
  targetstringrequired
  One ofworkspace.logo
  Option 3
  targetstringrequired
  One ofbrand.voice
  Option 4
  targetstringrequired
  One ofbrand.competitors
  Option 5
  targetstringrequired
  One ofpersona
  Option 6
  targetstringrequired
  One ofobjective
  metricKeystring
  Max length 100
  Option 7
  targetstringrequired
  One ofcampaign.creativeDirection
  Option 8
  targetstringrequired
  One ofcampaign.monthlyPostTarget
  kindstringrequired
  One ofemail
  Option 4
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  helpTextstring
  Max length 2000
  requiredboolean
  Default false
  showWhenobject
  Child attributes
  blockIdstringrequired
  Min length 1 · Max length 40
  opstringrequired
  One ofequalsnot_equalsincludesis_answered
  valuestring
  Max length 300
  mappingobject or object or object or object or object or object or object or object
  Option 1
  targetstringrequired
  One ofworkspace.name
  Option 2
  targetstringrequired
  One ofworkspace.logo
  Option 3
  targetstringrequired
  One ofbrand.voice
  Option 4
  targetstringrequired
  One ofbrand.competitors
  Option 5
  targetstringrequired
  One ofpersona
  Option 6
  targetstringrequired
  One ofobjective
  metricKeystring
  Max length 100
  Option 7
  targetstringrequired
  One ofcampaign.creativeDirection
  Option 8
  targetstringrequired
  One ofcampaign.monthlyPostTarget
  kindstringrequired
  One ofurl
  Option 5
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  helpTextstring
  Max length 2000
  requiredboolean
  Default false
  showWhenobject
  Child attributes
  blockIdstringrequired
  Min length 1 · Max length 40
  opstringrequired
  One ofequalsnot_equalsincludesis_answered
  valuestring
  Max length 300
  mappingobject or object or object or object or object or object or object or object
  Option 1
  targetstringrequired
  One ofworkspace.name
  Option 2
  targetstringrequired
  One ofworkspace.logo
  Option 3
  targetstringrequired
  One ofbrand.voice
  Option 4
  targetstringrequired
  One ofbrand.competitors
  Option 5
  targetstringrequired
  One ofpersona
  Option 6
  targetstringrequired
  One ofobjective
  metricKeystring
  Max length 100
  Option 7
  targetstringrequired
  One ofcampaign.creativeDirection
  Option 8
  targetstringrequired
  One ofcampaign.monthlyPostTarget
  kindstringrequired
  One ofurl_list
  maxItemsinteger
  Default 10 · Min 1 · Max 50
  Option 6
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  helpTextstring
  Max length 2000
  requiredboolean
  Default false
  showWhenobject
  Child attributes
  blockIdstringrequired
  Min length 1 · Max length 40
  opstringrequired
  One ofequalsnot_equalsincludesis_answered
  valuestring
  Max length 300
  mappingobject or object or object or object or object or object or object or object
  Option 1
  targetstringrequired
  One ofworkspace.name
  Option 2
  targetstringrequired
  One ofworkspace.logo
  Option 3
  targetstringrequired
  One ofbrand.voice
  Option 4
  targetstringrequired
  One ofbrand.competitors
  Option 5
  targetstringrequired
  One ofpersona
  Option 6
  targetstringrequired
  One ofobjective
  metricKeystring
  Max length 100
  Option 7
  targetstringrequired
  One ofcampaign.creativeDirection
  Option 8
  targetstringrequired
  One ofcampaign.monthlyPostTarget
  kindstringrequired
  One ofnumber
  minnumber
  maxnumber
  Option 7
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  helpTextstring
  Max length 2000
  requiredboolean
  Default false
  showWhenobject
  Child attributes
  blockIdstringrequired
  Min length 1 · Max length 40
  opstringrequired
  One ofequalsnot_equalsincludesis_answered
  valuestring
  Max length 300
  mappingobject or object or object or object or object or object or object or object
  Option 1
  targetstringrequired
  One ofworkspace.name
  Option 2
  targetstringrequired
  One ofworkspace.logo
  Option 3
  targetstringrequired
  One ofbrand.voice
  Option 4
  targetstringrequired
  One ofbrand.competitors
  Option 5
  targetstringrequired
  One ofpersona
  Option 6
  targetstringrequired
  One ofobjective
  metricKeystring
  Max length 100
  Option 7
  targetstringrequired
  One ofcampaign.creativeDirection
  Option 8
  targetstringrequired
  One ofcampaign.monthlyPostTarget
  kindstringrequired
  One ofdate
  Option 8
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  helpTextstring
  Max length 2000
  requiredboolean
  Default false
  showWhenobject
  Child attributes
  blockIdstringrequired
  Min length 1 · Max length 40
  opstringrequired
  One ofequalsnot_equalsincludesis_answered
  valuestring
  Max length 300
  mappingobject or object or object or object or object or object or object or object
  Option 1
  targetstringrequired
  One ofworkspace.name
  Option 2
  targetstringrequired
  One ofworkspace.logo
  Option 3
  targetstringrequired
  One ofbrand.voice
  Option 4
  targetstringrequired
  One ofbrand.competitors
  Option 5
  targetstringrequired
  One ofpersona
  Option 6
  targetstringrequired
  One ofobjective
  metricKeystring
  Max length 100
  Option 7
  targetstringrequired
  One ofcampaign.creativeDirection
  Option 8
  targetstringrequired
  One ofcampaign.monthlyPostTarget
  kindstringrequired
  One ofsingle_choice
  optionsarray of objectrequired
  Min items 2 · Max items 50
  Child attributes
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  allowOtherboolean
  Default false
  Option 9
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  helpTextstring
  Max length 2000
  requiredboolean
  Default false
  showWhenobject
  Child attributes
  blockIdstringrequired
  Min length 1 · Max length 40
  opstringrequired
  One ofequalsnot_equalsincludesis_answered
  valuestring
  Max length 300
  mappingobject or object or object or object or object or object or object or object
  Option 1
  targetstringrequired
  One ofworkspace.name
  Option 2
  targetstringrequired
  One ofworkspace.logo
  Option 3
  targetstringrequired
  One ofbrand.voice
  Option 4
  targetstringrequired
  One ofbrand.competitors
  Option 5
  targetstringrequired
  One ofpersona
  Option 6
  targetstringrequired
  One ofobjective
  metricKeystring
  Max length 100
  Option 7
  targetstringrequired
  One ofcampaign.creativeDirection
  Option 8
  targetstringrequired
  One ofcampaign.monthlyPostTarget
  kindstringrequired
  One ofmulti_choice
  optionsarray of objectrequired
  Min items 2 · Max items 50
  Child attributes
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  allowOtherboolean
  Default false
  Option 10
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  helpTextstring
  Max length 2000
  requiredboolean
  Default false
  showWhenobject
  Child attributes
  blockIdstringrequired
  Min length 1 · Max length 40
  opstringrequired
  One ofequalsnot_equalsincludesis_answered
  valuestring
  Max length 300
  mappingobject or object or object or object or object or object or object or object
  Option 1
  targetstringrequired
  One ofworkspace.name
  Option 2
  targetstringrequired
  One ofworkspace.logo
  Option 3
  targetstringrequired
  One ofbrand.voice
  Option 4
  targetstringrequired
  One ofbrand.competitors
  Option 5
  targetstringrequired
  One ofpersona
  Option 6
  targetstringrequired
  One ofobjective
  metricKeystring
  Max length 100
  Option 7
  targetstringrequired
  One ofcampaign.creativeDirection
  Option 8
  targetstringrequired
  One ofcampaign.monthlyPostTarget
  kindstringrequired
  One ofdropdown
  optionsarray of objectrequired
  Min items 2 · Max items 50
  Child attributes
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  Option 11
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  helpTextstring
  Max length 2000
  requiredboolean
  Default false
  showWhenobject
  Child attributes
  blockIdstringrequired
  Min length 1 · Max length 40
  opstringrequired
  One ofequalsnot_equalsincludesis_answered
  valuestring
  Max length 300
  mappingobject or object or object or object or object or object or object or object
  Option 1
  targetstringrequired
  One ofworkspace.name
  Option 2
  targetstringrequired
  One ofworkspace.logo
  Option 3
  targetstringrequired
  One ofbrand.voice
  Option 4
  targetstringrequired
  One ofbrand.competitors
  Option 5
  targetstringrequired
  One ofpersona
  Option 6
  targetstringrequired
  One ofobjective
  metricKeystring
  Max length 100
  Option 7
  targetstringrequired
  One ofcampaign.creativeDirection
  Option 8
  targetstringrequired
  One ofcampaign.monthlyPostTarget
  kindstringrequired
  One ofyes_no
  Option 12
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  helpTextstring
  Max length 2000
  requiredboolean
  Default false
  showWhenobject
  Child attributes
  blockIdstringrequired
  Min length 1 · Max length 40
  opstringrequired
  One ofequalsnot_equalsincludesis_answered
  valuestring
  Max length 300
  mappingobject or object or object or object or object or object or object or object
  Option 1
  targetstringrequired
  One ofworkspace.name
  Option 2
  targetstringrequired
  One ofworkspace.logo
  Option 3
  targetstringrequired
  One ofbrand.voice
  Option 4
  targetstringrequired
  One ofbrand.competitors
  Option 5
  targetstringrequired
  One ofpersona
  Option 6
  targetstringrequired
  One ofobjective
  metricKeystring
  Max length 100
  Option 7
  targetstringrequired
  One ofcampaign.creativeDirection
  Option 8
  targetstringrequired
  One ofcampaign.monthlyPostTarget
  kindstringrequired
  One ofscale
  mininteger
  Default 1
  maxinteger
  Default 5
  minLabelstring
  Max length 60
  maxLabelstring
  Max length 60
  Option 13
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  helpTextstring
  Max length 2000
  requiredboolean
  Default false
  showWhenobject
  Child attributes
  blockIdstringrequired
  Min length 1 · Max length 40
  opstringrequired
  One ofequalsnot_equalsincludesis_answered
  valuestring
  Max length 300
  mappingobject or object or object or object or object or object or object or object
  Option 1
  targetstringrequired
  One ofworkspace.name
  Option 2
  targetstringrequired
  One ofworkspace.logo
  Option 3
  targetstringrequired
  One ofbrand.voice
  Option 4
  targetstringrequired
  One ofbrand.competitors
  Option 5
  targetstringrequired
  One ofpersona
  Option 6
  targetstringrequired
  One ofobjective
  metricKeystring
  Max length 100
  Option 7
  targetstringrequired
  One ofcampaign.creativeDirection
  Option 8
  targetstringrequired
  One ofcampaign.monthlyPostTarget
  kindstringrequired
  One ofcolor_list
  maxItemsinteger
  Default 6 · Min 1 · Max 12
  Option 14
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  helpTextstring
  Max length 2000
  requiredboolean
  Default false
  showWhenobject
  Child attributes
  blockIdstringrequired
  Min length 1 · Max length 40
  opstringrequired
  One ofequalsnot_equalsincludesis_answered
  valuestring
  Max length 300
  mappingobject or object or object or object or object or object or object or object
  Option 1
  targetstringrequired
  One ofworkspace.name
  Option 2
  targetstringrequired
  One ofworkspace.logo
  Option 3
  targetstringrequired
  One ofbrand.voice
  Option 4
  targetstringrequired
  One ofbrand.competitors
  Option 5
  targetstringrequired
  One ofpersona
  Option 6
  targetstringrequired
  One ofobjective
  metricKeystring
  Max length 100
  Option 7
  targetstringrequired
  One ofcampaign.creativeDirection
  Option 8
  targetstringrequired
  One ofcampaign.monthlyPostTarget
  kindstringrequired
  One offile_upload
  acceptarray of stringrequired
  Min items 1 · Max items 20
  maxFilesinteger
  Default 5 · Min 1 · Max 20
  Option 15
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  helpTextstring
  Max length 2000
  requiredboolean
  Default false
  showWhenobject
  Child attributes
  blockIdstringrequired
  Min length 1 · Max length 40
  opstringrequired
  One ofequalsnot_equalsincludesis_answered
  valuestring
  Max length 300
  mappingobject or object or object or object or object or object or object or object
  Option 1
  targetstringrequired
  One ofworkspace.name
  Option 2
  targetstringrequired
  One ofworkspace.logo
  Option 3
  targetstringrequired
  One ofbrand.voice
  Option 4
  targetstringrequired
  One ofbrand.competitors
  Option 5
  targetstringrequired
  One ofpersona
  Option 6
  targetstringrequired
  One ofobjective
  metricKeystring
  Max length 100
  Option 7
  targetstringrequired
  One ofcampaign.creativeDirection
  Option 8
  targetstringrequired
  One ofcampaign.monthlyPostTarget
  kindstringrequired
  One ofstatement
  bodystringrequired
  Max length 2000
  confirmLabelstring
  Max length 300
  Option 16
  idstringrequired
  Min length 1 · Max length 40
  labelstringrequired
  Min length 1 · Max length 300
  helpTextstring
  Max length 2000
  requiredboolean
  Default false
  showWhenobject
  Child attributes
  blockIdstringrequired
  Min length 1 · Max length 40
  opstringrequired
  One ofequalsnot_equalsincludesis_answered
  valuestring
  Max length 300
  mappingobject or object or object or object or object or object or object or object
  Option 1
  targetstringrequired
  One ofworkspace.name
  Option 2
  targetstringrequired
  One ofworkspace.logo
  Option 3
  targetstringrequired
  One ofbrand.voice
  Option 4
  targetstringrequired
  One ofbrand.competitors
  Option 5
  targetstringrequired
  One ofpersona
  Option 6
  targetstringrequired
  One ofobjective
  metricKeystring
  Max length 100
  Option 7
  targetstringrequired
  One ofcampaign.creativeDirection
  Option 8
  targetstringrequired
  One ofcampaign.monthlyPostTarget
  kindstringrequired
  One ofconnect_channels
  platformsarray of stringrequired
  One ofblueskydiscordfacebookinstagramlinkedinpinterestthreadstiktokwordpressyoutube
  Min items 1
  minimuminteger
  Default 0 · Min 0
- outroobjectrequired
  Child attributes
  headingstringrequired
  Min length 1 · Max length 300
  bodystring
  Max length 2000
appliedBystringrequirednullable
appliedTargetsarray of objectrequired
Child attributes
- blockIdstringrequired
- targetstringrequired
- valuestringrequired
- appliedAtnumberrequired
createdAtstring (date-time)required
updatedAtstring (date-time)required

QuestionnaireResponseSummary

idstringrequired
linkIdstringrequired
statusstringrequired
One ofdraftsubmittedapplied
respondentNamestringrequirednullable
respondentEmailstringrequirednullable
startedAtstring (date-time)required
submittedAtstring (date-time)requirednullable
appliedAtstring (date-time)requirednullable

QuestionnaireSummary

idstringrequired
workspaceIdstringrequired
templateIdstringrequirednullable
templateVersionintegerrequirednullable
namestringrequired
descriptionstringrequirednullable
definitionVersionintegerrequired
statusstringrequired
One ofdraftactivearchived
createdBystringrequirednullable
createdAtstring (date-time)required
updatedAtstring (date-time)required
sectionCountintegerrequired
questionCountintegerrequired
linkCountintegerrequired
responseCountintegerrequired

QuestionnaireTemplateSummary

idstringrequired
organizationIdstringrequired
namestringrequired
descriptionstringrequirednullable
definitionVersionintegerrequired
starterKeystringrequirednullable
archivedbooleanrequired
archivedAtstring (date-time)requirednullable
createdBystringrequirednullable
createdAtstring (date-time)required
updatedAtstring (date-time)required
sectionCountintegerrequired
questionCountintegerrequired