EaserixDocs
DevelopersAPI referenceSignDocuments

Remove one field from a pending document

Only while its recipient (if any) hasn't signed yet.

View as Markdown
DELETE
/v1/documents/{id}/fields/{fid}

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
fid*string

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/v1/documents/string/fields/string"
{  "document": {    "id": "string",    "name": "string",    "url": "string",    "status": "string",    "created": "2019-08-24T14:15:22Z",    "modified": "2019-08-24T14:15:22Z",    "size": 0,    "pages": 0,    "templateId": "string",    "hasFile": true,    "hasFinalFile": true,    "files": [      {        "id": "string",        "name": "string",        "position": 0,        "size": 0,        "pages": 0,        "created": "2019-08-24T14:15:22Z",        "status": "ready",        "conversionError": "string"      }    ],    "signingMode": "string",    "message": "string",    "sentAt": "2019-08-24T14:15:22Z",    "completedAt": "2019-08-24T14:15:22Z",    "voidedAt": "2019-08-24T14:15:22Z",    "voidReason": "string",    "declinedAt": "2019-08-24T14:15:22Z",    "expiresAt": "2019-08-24T14:15:22Z",    "autoRemindDays": 0,    "lastRemindedAt": "2019-08-24T14:15:22Z",    "legalHold": true,    "scheduledPurgeAt": "2019-08-24T14:15:22Z",    "visibility": "string",    "ownerId": "string",    "requiresNotarization": true,    "notaryState": "string",    "recipients": [      {        "id": "string",        "name": "string",        "email": "string",        "role": "string",        "status": "string",        "orderIndex": 0,        "signedAt": "2019-08-24T14:15:22Z",        "viewedAt": "2019-08-24T14:15:22Z",        "declinedAt": "2019-08-24T14:15:22Z",        "declineReason": "string",        "hasAccessCode": true,        "signature": "string",        "isGroup": true,        "groupLabel": "string",        "signedByName": "string",        "signedByEmail": "string",        "members": [          {            "id": "string",            "name": "string",            "email": "string",            "viewedAt": "2019-08-24T14:15:22Z",            "declinedAt": "2019-08-24T14:15:22Z"          }        ],        "reassignedFromName": "string",        "reassignedFromEmail": "string",        "reassignReason": "string",        "reassignedAt": "2019-08-24T14:15:22Z"      }    ],    "fields": [      {        "id": "string",        "type": "signature",        "x": 0,        "y": 0,        "width": 0,        "height": 0,        "page": 0,        "required": true,        "label": "string",        "value": "string",        "recipientId": "string",        "fileId": "string",        "config": {}      }    ]  }}

Correct one field on a pending document

Moves, resizes, relabels, retoggles required, or reassigns one field, while the document is pending and that field's (and, on reassignment, the target's) recipient hasn't signed yet. Unlike PUT .../fields, this never touches any other field, never regenerates an id, and never drops a value. Recorded in the audit trail with what changed.

Copy a document into a new draft

Creates a fresh draft owned by the caller with the same file, recipients and field placements, and none of the signing state — no tokens, signatures, or viewed/signed timestamps, and filled values dropped. The file blob is copied rather than shared, so deleting either document cannot affect the other. For re-running an agreement without rebuilding its layout.