SOsoraban
Questionnaires

Send a questionnaire

Changed on

Creates a questionnaire from one of the firm's templates and sends it to the entity's client. This notifies the client unless disable_notification is true.

The template is looked up by name, so it must match a template on the firm exactly.

post/questionnaires/send_questionnaire_api

Request

Request body

entity_idinteger
external_entity_idstring
questionnaire_template_namestring required

Must match one of the firm's template names exactly.

tax_yearinteger required
due_datestring date

Due date shown to the client.

sectionsstring[]

Only include these template sections. Names that do not exist on the template are ignored; if none match, the whole template is sent.

include_rolloverboolean

Carry prior-year items into the questionnaire.

disable_notificationboolean

Create and send the questionnaire without emailing or texting the client.

Example request

{
  "tax_year": 2025
}

Response

The questionnaire was created and sent.

messagestring
questionnaire_idinteger
questionnaire_namestring
questionnaire_linkstring uri

A link the client can open. For clients who have not set a password this includes a one-time sign-in token.

sent_tostring email

Example response

{
  "message": "Successfully sent questionnaire."
}

Changes

  • 1c230fa547adRevision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • info

      api operation id sendQuestionnaire was added

    • info

      the endpoint scheme security bearerAuth was removed from the API

    • info

      api tag Questionnaires added

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status