Raw schema
{
"type": "object",
"properties": {
"form_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "The form to dispatch (from gocanvas_list_forms)."
},
"dispatch_type": {
"type": "string",
"enum": [
"immediate_dispatch",
"scheduled_dispatch"
],
"description": "immediate_dispatch is sent now; scheduled_dispatch at scheduled_at."
},
"assignee_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "The user who gets the dispatch (from gocanvas_list_users); omit to leave it unassigned."
},
"name": {
"description": "Short name shown on the dispatch calendar.",
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"description": "Description shown on the assignee's device.",
"type": "string",
"maxLength": 2000
},
"department_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Department; default is the user's default department."
},
"responses": {
"description": "Pre-filled answers.",
"maxItems": 500,
"type": "array",
"items": {
"type": "object",
"properties": {
"entry_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "The form entry id (from gocanvas_get_form)."
},
"value": {
"type": "string",
"maxLength": 5000,
"description": "The value to pre-fill, as text."
},
"multi_key": {
"description": "Only for looped forms: reference to the looped value (one key per loop row).",
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"entry_id",
"value"
]
}
},
"send_notification": {
"description": "Immediate dispatches: send a push notification to the mobile app.",
"type": "boolean"
},
"scheduled_at": {
"description": "Scheduled dispatches: start, in the format MM/DD/YYYY h:mm:ss AM, e.g. 12/1/2024 8:00:00 AM.",
"type": "string",
"minLength": 6,
"maxLength": 40
},
"scheduled_end": {
"description": "Scheduled dispatches: end, same format.",
"type": "string",
"minLength": 6,
"maxLength": 40
},
"reminder_interval": {
"description": "Scheduled dispatches: minutes before the start to send a reminder.",
"type": "integer",
"minimum": 0,
"maximum": 100000
},
"send_calendar_invite": {
"description": "Scheduled dispatches: send a calendar invite.",
"type": "boolean"
}
},
"required": [
"form_id",
"dispatch_type"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}