Patch documents by ID | CloudRaker documentation

{
  "id": "string",
  "title": "string",
  "teamId": "string",
  "ownerId": "string",
  "privacy": "team",
  "status": "draft",
  "message": "string",
  "placement": "page",
  "stages": [
    {
      "id": "string",
      "mode": "all",
      "recipients": [
        {
          "id": "string",
          "name": "string",
          "email": "string",
          "status": "pending",
          "delegationId": "string",
          "signedAt": "string",
          "typedName": "string",
          "viewedAt": "string",
          "approvedAt": "string",
          "declinedAt": "string",
          "declineReason": "string",
          "nextReminderAt": "string",
          "lastInvitedAt": "string",
          "deliveryError": "string",
          "version": 1
        }
      ],
      "role": "signer",
      "delayHours": 1.1,
      "condition": {},
      "skipped": true
    }
  ],
  "fields": [
    {
      "id": "string",
      "kind": "signature",
      "slot": 1,
      "page": 1,
      "x": 0.5,
      "y": 0.5,
      "width": 0.5,
      "height": 0.5,
      "label": "string",
      "required": true,
      "options": [
        "string"
      ],
      "maxLength": 1,
      "defaultValue": "string",
      "attachmentId": "string",
      "localPage": 1
    }
  ],
  "createdAt": "string",
  "updatedAt": "string",
  "version": 1,
  "activity": [
    {
      "id": "string",
      "at": "string",
      "text": "string"
    }
  ],
  "source": "app",
  "integrationId": "string",
  "integrationName": "string",
  "signingMode": "manual",
  "delegation": {
    "templateId": "string",
    "templateVersion": 1
  },
  "templateOrigin": {
    "templateId": "string",
    "templateVersion": 1,
    "templateName": "string"
  },
  "attachments": [
    {
      "id": "string",
      "fileId": "string",
      "name": "string",
      "mimeType": "string",
      "pageCount": 1,
      "startPage": 1,
      "sha256": "string",
      "renditionSha256": "string"
    }
  ],
  "pageCount": 1,
  "pages": [
    {
      "width": 1.1,
      "height": 1.1
    }
  ],
  "preparationReviewed": true,
  "contentNeedsRender": true,
  "cc": [
    {
      "name": "string",
      "email": "string"
    }
  ],
  "language": "en",
  "expiresInDays": 1.1,
  "expiresAt": "string",
  "reminders": {
    "enabled": true,
    "firstAfterDays": 1.1,
    "repeatEveryDays": 1.1,
    "expiresBeforeDays": 1
  },
  "allowReassignment": true,
  "branding": {
    "name": "string",
    "accentColor": "string",
    "logoDataUrl": "string"
  },
  "variables": {},
  "brandingId": "string",
  "purpose": "string",
  "generation": {},
  "extraction": {},
  "postSign": {},
  "fileName": "string",
  "fileId": "string",
  "generatedText": "string",
  "runId": "string",
  "error": "string",
  "sending": true,
  "errorCode": "concurrent_envelope_limit",
  "limit": 1,
  "sentAt": "string",
  "completedAt": "string"
}

Uses the same resource permissions and lifecycle as the RakeSign application. Integration access is limited to its shared team. Required scopes: documents:write.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Request

This endpoint expects an object.

generatedTextstringOptional<=50000 characters

generationobjectOptional

titlestringOptional1-200 characters

teamIdstring or nullOptional1-200 characters

privacyenumOptional

Allowed values:

messagestringOptional<=2000 characters

signingModeenumOptional

Allowed values:

delegationobject or nullOptional

placementenumOptional

Allowed values:

fieldslist of objectsOptional

preparationReviewedbooleanOptional

cclist of objectsOptional

languageenumOptional

Allowed values:

expiresInDaysdoubleOptional

remindersobjectOptional

allowReassignmentbooleanOptional

brandingobject or nullOptional

brandingIdstring or nullOptional1-200 characters

variablesmap from strings to strings or doubles or booleans or lists of SigningJsonValue or maps from strings to SigningJsonValueOptional

versionintegerOptional0-9007199254740991

stageslist of objectsOptional

Response

Authorized signing resource.

idstring

titlestring

teamIdstring or null

ownerIdstring

privacyenum

Allowed values:

statusenum

messagestring

placementenum

Allowed values:

stageslist of objects

fieldslist of objects

createdAtstring

updatedAtstring

versioninteger-9007199254740991-9007199254740991

activitylist of objects

sourceenumOptional

Allowed values:

integrationIdstringOptional

integrationNamestringOptional

signingModeenumOptional

Allowed values:

delegationobject or nullOptional

templateOriginobjectOptional

attachmentslist of objectsOptional

pageCountintegerOptional-9007199254740991-9007199254740991

pageslist of objectsOptional

preparationReviewedbooleanOptional

contentNeedsRenderbooleanOptional

cclist of objectsOptional

languageenumOptional

Allowed values:

expiresInDaysdoubleOptional

expiresAtstringOptional

remindersobjectOptional

allowReassignmentbooleanOptional

brandingobject or nullOptional

variablesmap from strings to nullable strings or doubles or booleans or lists of __schema0 or maps from strings to __schema0Optional

brandingIdstring or nullOptional

purpose"template"Optional

generationmap from strings to nullable strings or doubles or booleans or lists of __schema0 or maps from strings to __schema0Optional

extractionmap from strings to nullable strings or doubles or booleans or lists of __schema0 or maps from strings to __schema0Optional

postSignmap from strings to nullable strings or doubles or booleans or lists of __schema0 or maps from strings to __schema0Optional

fileNamestringOptional

fileIdstringOptional

generatedTextstringOptional

runIdstringOptional

errorstringOptional

sendingbooleanOptional

A send is underway or was interrupted. Edits answer 409 until it ends; POST /send again to finish it.

errorCodeenumOptional

Set on a failed document when the plan limit of open signing requests stopped the send.

Allowed values:

limitintegerOptional-9007199254740991-9007199254740991

With errorCode: the open signing request limit of the plan.

sentAtstringOptional

completedAtstringOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

429

Too Many Requests Error

503

Service Unavailable Error