Getting started

This walkthrough creates a packet from one of your templates and sends it for signing.

Before you start

You need:

• A DocRunner account with at least one packet template that contains a document.
• Your API key, from Settings > Developer Tools > API Keys.

Prefer a GUI? Download the Postman collection and environment, import both, and set apiKey in the environment instead of following the curl examples below.

The examples use curl and assume your key is in an environment variable:

export DOCRUNNER_API_KEY="your-api-key-here"

1. Find your packet template

curl https://app.docrunner.io/api/packet_templates \
  -H "X-API-Key: $DOCRUNNER_API_KEY"

Note the id of the template you want. To see its signer roles, fetch the template by ID and read recipient_roles:

curl https://app.docrunner.io/api/packet_templates/9 \
  -H "X-API-Key: $DOCRUNNER_API_KEY"

2. Create the packet

Signers are grouped by role. Each role key must match a role key on the template.

curl -X POST https://app.docrunner.io/api/packets \
  -H "X-API-Key: $DOCRUNNER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "packet": {
      "packet_template_id": 9,
      "packet_name": "Lease for 123 Main St",
      "roles": {
        "tenant": [{ "name": "Jane Doe", "email": "jane@example.com" }],
        "owner": [{ "name": "John Smith", "email": "john@example.com" }]
      }
    }
  }'

The response contains the new packet with status set to draft. Note its id.

3. Send it for signing

curl -X POST https://app.docrunner.io/api/packets/123/send \
  -H "X-API-Key: $DOCRUNNER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "packet": { "send_email_body": "Please review and sign." } }'

Signers receive their signing links by email.

4. Track progress

Poll the status endpoint:

curl https://app.docrunner.io/api/packets/123/status \
  -H "X-API-Key: $DOCRUNNER_API_KEY"

Or subscribe to outgoing webhooks and let DocRunner notify you when each signer opens and signs.

Testing without sending email

If the packet template is in test mode, sending does not email anyone. The send response returns the signing links instead, so you can walk through signing yourself. See Send a packet.