Send a questionnaire to a client/entity

Triggers asynchronous creation and delivery of a questionnaire based on a template. Exactly one of these identification is required: (1) entity_id, OR (2) external_entity_id.

post/questionnaires/send_questionnaire_api

Request body

entity_idinteger

Soraban entity ID.

external_entity_idstring

External system identifier for the entity.

questionnaire_template_namestring required

Name of the questionnaire template to use.

tax_yearinteger required

Tax year to associate with the questionnaire.

due_datestring date nullable

Due date (YYYY-MM-DD).

include_rolloverboolean

Include prior-year items (rollover items) in the questionnaire.

disable_notificationboolean

Disables notification sending

sectionsstring[] nullable

Array of section names to include in the questionnaire. If not provided, all sections from the template will be included.

Response

Queued successfully

messagestring required

questionnaire_idinteger required

The ID of the created questionnaire.

questionnaire_namestring required

The name of the questionnaire.

questionnaire_linkstring required

The link to access the questionnaire (with authentication token if the user has not yet set login method).

sent_tostring email required

The email address of the user the questionnaire was sent to.

Example response

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

Changes

No recorded changes to this endpoint across all 1 revision of this API.