API Changelog

​

Version Summary

​

v01.03.00

​

New Features

​

Email Domains API

• GET /company/domains - List all company email domains
• POST /company/domains - Add a new email domain
• GET /company/domains/{id} - Get domain details
• DELETE /company/domains/{id} - Delete a domain
• POST /company/domains/{id}/verify-ownership - Verify domain ownership via TXT record
• POST /company/domains/{id}/finalize - Complete domain setup with email provider
• POST /company/domains/{id}/verify-dns - Verify SPF, DKIM, DMARC records
• POST /company/domains/{id}/set-primary - Set primary sending domain

• Domain - Email domain configuration with verification status
• DomainDnsRecord - DNS record details for domain verification

​

Credit Cost Tracking

• Added credit_cost field to Template schema - Number of credits consumed when sending
• Added credit_cost field to SigningRequest schema - Credits consumed when sent
• Added show_credit_cost_in_editor to WorkspaceSettings - Toggle credit display in editors

​

Signing Request Declined Status

• Added declined to SigningRequest.status enum values
• Added date_declined field to SigningRequest schema

​

Schema Improvements

​

Template Fields

• Added date_default field for setting default date values (ISO 8601 format)
• Enhanced multi_group_id description: explains mutually exclusive field grouping for checkboxes/radio buttons
• Added clarification that page_number is 1-indexed and must not exceed document page count

​

Signing Request Fields

• Enhanced multi_group_id description with same improvements as template fields

​

v01.02.00

​

Enhanced User Information

​

TemplateUser Schema Enhancements

• first_name - Recipient first name
• last_name - Recipient last name
• phone_number - Contact phone number
• street_address - Street address
• city - City
• state_province - State or province
• postal_code - Postal/ZIP code
• country - Country
• title - Job title
• company - Company name

​

Ready-to-Send Indicators

• required_fields - List of required recipient data fields based on template configuration
• missing_fields - List of required fields that are currently empty
• required_read_only_fields - Read-only fields needing pre-filled values
• ready_to_send - Boolean indicating if recipient has all required data

​

SigningRequestUser Schema Enhancements

• declined_on - Timestamp when recipient declined to sign
• decline_reason - Reason provided by recipient for declining
• custom_fields - Custom field values for the recipient
• has_value property in required_read_only_fields - Indicates if read-only field has a value

​

Response Format Changes

{
  "results": [
    {
      "id": "uuid",
      "name": "John Doe",
      "first_name": "John",
      "last_name": "Doe",
      "email": "john@example.com",
      "designation": "Signer",
      "order": 1,
      "required_fields": ["email", "first_name"],
      "missing_fields": [],
      "ready_to_send": true
    }
  ]
}

​

v01.01.00

​

New Endpoints

​

Template Management

• POST /templates - Create a new template with base64-encoded PDF
• PATCH /templates/{id} - Partial update (properties OR single user)
• PUT /templates/{id} - Comprehensive update (properties, users, fields, reminders)
• DELETE /templates/{id} - Soft delete a template

​

Template Sub-Resources

• GET /templates/{id}/users - Get all template recipients
• GET /templates/{id}/fields - Get all template fields
• GET /templates/{id}/reminders - Get all template reminders

​

API Key Management

• POST /workspaces/{id}/api-key/regenerate - Generate new API key with 24-hour grace period
• POST /workspaces/{id}/api-key/expire - Immediately expire pending keys

​

Enhanced Operations

​

Comprehensive Updates

• template_properties - Update metadata and settings
• users - Upsert users (include id to update, omit to create)
• deleted_users - Delete users with field handling strategy (delete or reassign)
• fields - Upsert fields
• reminders - Upsert reminders

{
  "template_properties": {
    "name": "Updated Template",
    "settings": {
      "allow_editing_before_sending": true
    }
  },
  "users": [
    {
      "id": "existing-uuid",
      "email": "updated@example.com"
    },
    {
      "first_name": "New",
      "last_name": "Signer",
      "email": "new@example.com",
      "designation": "Signer",
      "order": 2
    }
  ],
  "deleted_users": [
    {
      "user_id": "user-to-delete",
      "field_action": "reassign",
      "reassign_to_user_id": "existing-uuid"
    }
  ]
}

​

v01.00.02

​

New Features

​

Custom Fields API

• Custom Fields - Custom field definition management

WorkspaceCustomField

{
  "id": "uuid",
  "field_name": "string",
  "field_label": "string",
  "is_preset": true,
  "preset_value": "string",
  "created_at": "datetime",
  "updated_at": "datetime"
}

TemplateCustomField

{
  "id": "uuid",
  "field_name": "string",
  "field_label": "string",
  "created_at": "datetime",
  "updated_at": "datetime"
}

SigningRequestCustomField

{
  "id": "uuid",
  "field_name": "string",
  "field_label": "string",
  "copied_from_template": true,
  "created_at": "datetime",
  "updated_at": "datetime"
}

​

Schema Improvements

​

TemplateField Schema

• Explicit type property with enum values
• position object with x, y, width, height
• read_only and read_only_value for pre-filled fields

​

v01.00.01

​

Initial Release

​

API Tags / Categories

• Company - Company information and settings
• Workspaces - Workspace management operations
• Templates - Template management operations
• Signing Requests - Document signing request operations
• Webhooks - Webhook configuration and management
• JWT Management - JWT token generation and revocation
• Workspace Settings - Workspace configuration
• Legacy - Deprecated endpoints for backward compatibility

​

Authentication

• API key authentication via Authorization header
• Optional Bearer prefix support

​

Rate Limiting

• Read operations (GET): 200 requests/minute
• Write operations (POST/PUT/PATCH/DELETE): 120 requests/minute
• Webhook CRUD: 60 requests/minute
• Webhook test: 10 requests/minute
• API key operations: 1 request/minute
• Secret rotation: 1 request/minute

​

Core Schemas

Company

• id, company_name, account_owner, account_owner_email
• website, icon_url, credits (read-only)
• date_created, date_changed

Workspace

• id, name, protected, api_key
• date_created, date_changed

Template

• id, name, description
• document_url (pre-signed, expires)
• document_url_expires_at
• date_created, date_changed

SigningRequest

• id, name, description
• document_url, document_url_expires_at
• document_page_count, status, expiration_hours
• settings, template_id
• Date fields: date_created, date_sent, date_finished, date_cancelled, expires_at
• certificate object with generation status
• final_document_download_url, final_document_download_error

Recipient

• Core: id, first_name, last_name, email, designation, order
• Address: street_address, city, state_province, postal_code, country
• Professional: phone_number, title, company
• custom_fields for additional data
• Temporary ID support for document-based creation

Field

• id, type, position, page_number, required
• recipient_id, variable_name
• Type-specific: dropdown_options, date_default, date_signing_default
• Read-only: read_only, read_only_value, prefilled_data
• Formatting: format_rules, validation_rules

Webhook

• id, url, events, enabled
• date_created, date_changed

​

JWT Management

• Generate JWT for template embedding
• Generate JWT for signing request embedding
• Revoke JWT tokens

​

Migration Guide

​

Migrating from v01.00.01 to v01.00.02

• No breaking changes
• Custom Fields API available for use

​

Migrating from v01.00.02 to v01.01.00

• No breaking changes
• New template management endpoints available
• API key regeneration endpoints available

​

Migrating from v01.01.00 to v01.02.00

• No breaking changes
• Template and signing request users now include additional fields
• ready_to_send boolean available to check recipient readiness

​

Migrating from v01.02.00 to v01.03.00

• No breaking changes
• Email domain configuration available for custom sending domains
• declined status added to signing request status enum
• Credit cost tracking available on templates and signing requests