SignWell · Schema

BulkSendResponse

Bulk send details

E-SignatureElectronic SignatureDocumentsPDFSigningTemplatesWorkflowsHIPAASOC2

Properties

Name	Type	Description
id	string
name	string
api_application_id	string
documents_count	integer
documents_completed	integer
documents_not_completed	integer
created_at	string
user_id	string
status	string
templates	array

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/signwell/main/json-schema/BulkSendResponse.json",
  "title": "BulkSendResponse",
  "type": "object",
  "description": "Bulk send details",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "type": "string"
    },
    "api_application_id": {
      "type": "string",
      "format": "uuid",
      "nullable": true
    },
    "documents_count": {
      "type": "integer"
    },
    "documents_completed": {
      "type": "integer"
    },
    "documents_not_completed": {
      "type": "integer"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "user_id": {
      "type": "string",
      "format": "uuid",
      "nullable": true
    },
    "status": {
      "type": "string"
    },
    "templates": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name"
        ]
      }
    }
  },
  "required": [
    "id",
    "documents_count",
    "created_at",
    "status"
  ]
}