Skip to navigation
RakeSign APIRake Sign

Post documents

View as Markdown

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.

Headers

Idempotency-KeystringOptional8-200 characters
Reuse a key for a retry with the same request body.

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
purposeenumOptional
Allowed values:

Response

An existing document for this idempotency key.
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