swiftsign_send_envelope

Parameters schema

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "subject",
    "documents",
    "recipients",
    "fields"
  ],
  "properties": {
    "fields": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "recipientIndex",
          "type",
          "page",
          "x",
          "y"
        ],
        "properties": {
          "x": {
            "type": "number",
            "description": "X position, percent 0-100 of page width, top-left origin"
          },
          "y": {
            "type": "number",
            "description": "Y position, percent 0-100 of page height, top-left origin"
          },
          "page": {
            "type": "number",
            "description": "Page number (1-based). Ignored when anchor resolves."
          },
          "type": {
            "enum": [
              "SIGNATURE",
              "NAME",
              "DATE",
              "TEXT",
              "INITIALS",
              "CHECKBOX",
              "RADIO",
              "DROPDOWN",
              "ATTACHMENT"
            ],
            "type": "string",
            "description": "Field type"
          },
          "width": {
            "type": "number",
            "description": "Field width (percent)"
          },
          "anchor": {
            "type": "string",
            "description": "Anchor text to search in the PDF. Use anchor OR page+x+y, not both."
          },
          "height": {
            "type": "number",
            "description": "Field height (percent)"
          },
          "options": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Choices for RADIO / DROPDOWN fields"
          },
          "yOffset": {
            "type": "number",
            "description": "Y offset from anchor (percent)"
          },
          "document": {
            "type": "number",
            "default": 0,
            "description": "Document index (0-based)"
          },
          "recipientIndex": {
            "type": "number",
            "description": "Index into recipients array (0-based)"
          }
        }
      },
      "description": "Signing fields to place on documents"
    },
    "confirm": {
      "type": "boolean",
      "description": "Set true to dispatch immediately on a LIVE key (sk_live_/sk_oat_). Without it, live envelopes are created as DRAFT and returned for human review before anything is emailed. Test keys (sk_test_) always send immediately (sandbox, watermarked)."
    },
    "message": {
      "type": "string",
      "description": "Optional message to include"
    },
    "subject": {
      "type": "string",
      "description": "Email subject / document title"
    },
    "documents": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "name",
          "base64"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "Document filename (e.g. 'contract.pdf')"
          },
          "base64": {
            "type": "string",
            "description": "Base64-encoded PDF content"
          }
        }
      },
      "description": "PDF documents to send"
    },
    "recipients": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "name",
          "email"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "Recipient full name"
          },
          "role": {
            "enum": [
              "SIGNER",
              "CC"
            ],
            "type": "string",
            "default": "SIGNER"
          },
          "email": {
            "type": "string",
            "description": "Recipient email address"
          },
          "routingOrder": {
            "type": "number",
            "default": 1,
            "description": "Signing order (1 = first)"
          }
        }
      },
      "description": "People who need to sign or receive a copy"
    }
  }
}

No endpoints wrapped at confidence ≥ 0.70.

Parent server