Patch templates by ID

PATCH

https://api.cloudraker.com/v1/signing/templates/:id

PATCH

/v1/signing/templates/:id

curl -X PATCH https://api.cloudraker.com/v1/signing/templates/id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "version": 1
}'

{
  "id": "string",
  "ownerId": "string",
  "teamId": "string",
  "privacy": "team",
  "version": 1,
  "createdAt": "string",
  "updatedAt": "string",
  "archivedAt": "string",
  "name": "string",
  "description": "string",
  "roles": [
    {
      "id": "string",
      "slot": 1,
      "label": "string"
    }
  ],
  "snapshot": {
    "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: templates:write, documents:read.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Request

This endpoint expects an object.

versionintegerRequired1-9007199254740991

documentIdstringOptional1-200 characters

namestringOptional1-200 characters

descriptionstringOptional<=2000 charactersDefaults to

roleslist of objectsOptional

teamIdstring or nullOptional1-200 characters

Response

Authorized signing resource.

idstring

ownerIdstring

teamIdstring or null

privacyenum

Allowed values:

versioninteger-9007199254740991-9007199254740991

createdAtstring

updatedAtstring

archivedAtstring or null

namestring

descriptionstring

roleslist of objects

snapshotobject

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