SignWell · Schema

BulkSendCsvRequest

E-SignatureElectronic SignatureDocumentsPDFSigningTemplatesWorkflowsHIPAASOC2

Properties

Name Type Description
template_ids array Specify one or more templates to generate a single blank CSV file that will contain available columns for your recipient data. The template_ids[] parameter is an array of template IDs (e.g.,`/?templat
bulk_send_csv string A RFC 4648 base64 string of the template CSV file to be validated.
View JSON Schema on GitHub

JSON Schema

BulkSendCsvRequest.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/signwell/main/json-schema/BulkSendCsvRequest.json",
  "title": "BulkSendCsvRequest",
  "type": "object",
  "properties": {
    "template_ids": {
      "type": "array",
      "description": "Specify one or more templates to generate a single blank CSV file that will contain available columns for your recipient data. The template_ids[] parameter is an array of template IDs (e.g.,`/?template_ids[]=5a67dbd7-928a-4ea0-a7e2-e476a0eb045f&template_ids[]=d7315111-c671-4b15-8354-c9a19bbaefa0`). Each ID should be a separate parameter in the query string.",
      "items": {
        "type": "string",
        "format": "uuid",
        "example": "00000000-0000-0000-0000-000000000000"
      }
    },
    "bulk_send_csv": {
      "type": "string",
      "description": "A RFC 4648 base64 string of the template CSV file to be validated.",
      "example": "bmFtZSxlbWFpbApUZXN0LHRlc3RAZXhhbXBsZS5jb20K"
    }
  },
  "required": [
    "template_ids",
    "bulk_send_csv"
  ]
}