Send DataForm to Client

POST /tenants/{tenant}/data-forms/{code}/send

Sends a published form to a single client, creating a form request and sending a notification email. When scheduledAt is set, nothing is created now: a scheduled send dispatches it at that time and 202 is returned.

Requires: ViewAll on Clients and Update on DataForms.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

code* path string

Request Body*

{
  "clientCode": "string",
  "notifyUserCode": "string",
  "autoAcceptData": false,
  "message": "string",
  "recipients": {
    "includeBusinessEmail": false,
    "contactTypes": [
      "..."
    ],
    "userTypes": [
      "..."
    ],
    "emailAddresses": [
      "..."
    ]
  }
}

Responses

202 Accepted
400 Bad Request
401 Unauthorized – Invalid or missing API key
403 Forbidden – the caller lacks the permissions this endpoint requires; the detail lists every one missing
application/problem+json
404 Not Found