Put forms by ID

PUT

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

PUT

/v1/signing/forms/:id

curl -X PUT https://api.cloudraker.com/v1/signing/forms/id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "string",
  "templateId": "string",
  "requesterRoleId": "string",
  "fixedRecipients": [
    {
      "roleId": "string",
      "name": "string",
      "email": "string"
    }
  ],
  "inputs": [
    {
      "key": "string",
      "label": "string",
      "type": "text",
      "required": true
    }
  ]
}'

{
  "name": "string",
  "templateId": "string",
  "requesterRoleId": "string",
  "fixedRecipients": [
    {
      "roleId": "string",
      "name": "string",
      "email": "string"
    }
  ],
  "inputs": [
    {
      "key": "string",
      "label": "string",
      "type": "text",
      "required": true,
      "columns": [
        "string"
      ]
    }
  ],
  "version": 1,
  "id": "string",
  "ownerId": "string",
  "status": "draft",
  "createdAt": "string",
  "updatedAt": "string",
  "description": "",
  "publicPath": "string"
}

Uses the same resource permissions and lifecycle as the RakeSign application. Integration access is limited to its shared team. Required scopes: forms:write, templates: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.

namestringRequired1-200 characters

templateIdstringRequiredformat: "^[\w-]+$"1-100 characters

requesterRoleIdstringRequiredformat: "^[\w-]+$"1-100 characters

fixedRecipientslist of objectsRequired

inputslist of objectsRequired

descriptionstringOptional<=2000 charactersDefaults to

versionintegerOptional<=9007199254740991

Response

Authorized signing resource.

namestring1-200 characters

templateIdstringformat: "^[\w-]+$"1-100 characters

requesterRoleIdstringformat: "^[\w-]+$"1-100 characters

fixedRecipientslist of objects

inputslist of objects

versioninteger-9007199254740991-9007199254740991

idstring

ownerIdstring

statusenum

Allowed values:

createdAtstring

updatedAtstring

descriptionstringOptional<=2000 charactersDefaults to

publicPathstringOptional

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