API ReferenceDocsign
Back to Platform

PATCH /docsign/documents/{id}

PATCH
/docsign/documents/{id}

PATCH operation for /docsign/documents/{id}

Authorization

ApiKeyAuth
Authorization<token>

API key authentication. Format: Your API key (no "Token" prefix needed)

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PATCH "https://rest.onboard.io/docsign/documents/string" \  -H "Content-Type: application/json" \  -d '{    "onboardee_company": "string",    "name": "string",    "original_pdf": "binary-file-placeholder"  }'
{
  "id": "string",
  "onboarder_company": "string",
  "onboardee_company": "string",
  "roadmap_task": "string",
  "source_document": "string",
  "name": "string",
  "status": "draft",
  "original_pdf": "binary-file-placeholder",
  "signed_pdf_available": "string",
  "signature_display_mode": "string",
  "page_count": 1,
  "pages": {},
  "original_hash": "string",
  "final_hash": "string",
  "finalized_at": "2021-01-01T00:00:00Z",
  "completed_at": "2021-01-01T00:00:00Z",
  "created_at": "2021-01-01T00:00:00Z",
  "modified_at": "2021-01-01T00:00:00Z",
  "signers": "string",
  "custom_message": "string",
  "presentation": "string"
}
Empty
Empty
Empty

How is this guide?

GET /docsign/documents/{id} GET

GET operation for /docsign/documents/{id}

DELETE /docsign/documents/{id} DELETE

DELETE operation for /docsign/documents/{id}