CreateBulkSendRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/signwell/main/json-schema/CreateBulkSendRequest.json",
  "title": "CreateBulkSendRequest",
  "type": "object",
  "properties": {
    "template_ids": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid",
        "example": "00000000-0000-0000-0000-000000000000"
      },
      "description": "Unique identifiers for a list of templates."
    },
    "bulk_send_csv": {
      "type": "string",
      "description": "A RFC 4648 base64 string of the template CSV file to be validated.",
      "example": "bmFtZSxlbWFpbApUZXN0LHRlc3RAZXhhbXBsZS5jb20K"
    },
    "skip_row_errors": {
      "type": "boolean",
      "default": false,
      "description": "Whether to skip errors in the rows. Defaults to `false`."
    },
    "api_application_id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique identifier for API Application settings to use. API Applications are optional and mainly used when isolating OAuth apps or for more control over embedded API settings"
    },
    "name": {
      "type": "string",
      "description": "The name of the Bulk Send. Will be used as the document name for each of the documents."
    },
    "subject": {
      "type": "string",
      "description": "Email subject for the signature request that recipients will see. Defaults to the default system subject or a template subject."
    },
    "message": {
      "type": "string",
      "description": "Email message for the signature request that recipients will see. Defaults to the default system message or a template message."
    },
    "apply_signing_order": {
      "type": "boolean",
      "default": false,
      "description": "When set to `true` recipients will sign one at a time in the order of the `recipients` collection of this request."
    },
    "custom_requester_name": {
      "type": "string",
      "description": "Sets the custom requester name for the document. When set, this is the name used for all email communications, signing notifications, and in the audit file."
    },
    "custom_requester_email": {
      "type": "string",
      "format": "email",
      "description": "Sets the custom requester email for the document. When set, this is the email used for all email communications, signing notifications, and in the audit file."
    }
  },
  "required": [
    "template_ids",
    "bulk_send_csv"
  ]
}