Send a contract to the workflow engine and initiate a workflow

Authorization

basicAuth

AuthorizationBasic <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Data object representing the request body to be sent when creating / canceling a contract

callbackURL?string

The endpoint URL where the callbacks must be sent. If not set, we recommend to set the metaData keepContractData to true to avoid automatic data deletion when contract is processed.

Formaturl

expiresAt?string

The date on which the contract must be moved to the 'EXPIRED' state. If not set, the contract will not expire

Formatdate-time

id?string

The id of the contract. If not set, a ID is automatically generated

metaData?

Additional properties that may be required by the workflows and the clients

multiSignaturesWorkflowId?string

The ID of a secondary workflow that will handle multi signatures use case (Envelopes, multi users, etc.). E.g. : serialSignatures

payload*string

The payload of the contract. The format may vary depending the type and workflowId

Formatbyte

pushNotificationMessage?

The configuration of the push notification sent to mobile device when the contract is submitted

state?string

The state of the contract. Only required with value CANCELED when canceling contract

type*string

The type of the contract indicating the format of the payload to the workflows and the clients (e.g PDF, ENVELOPE, LOGIN, etc.)

usernames*array<string>

The collection of the usernames

workflowId*string

The ID of the workflow (e.g rss, standard, etc.)

Response Body

`application/json`

Callbacks

curl -X POST "https://example.com/api/admin/contracts" \  -H "Content-Type: application/json" \  -d '{    "payload": "string",    "type": "string",    "usernames": [      "string"    ],    "workflowId": "string"  }'

{  "callbackURL": "string",  "childContracts": [    {}  ],  "date": "2019-08-24T14:15:22Z",  "domainName": "string",  "errors": [    {      "code": "string",      "data": "string",      "date": "2019-08-24T14:15:22Z",      "message": "string"    }  ],  "expiresAt": "2019-08-24T14:15:22Z",  "id": "string",  "metaData": {    "property1": "string",    "property2": "string"  },  "multiSignaturesWorkflowId": "string",  "payload": "string",  "responses": [    {      "context": {        "property1": "string",        "property2": "string"      },      "contractId": "string",      "data": "string",      "date": "2019-08-24T14:15:22Z",      "domainName": "string",      "id": "string",      "rejectionMessage": "string",      "response": "string",      "signature": "string",      "username": "string"    }  ],  "state": "string",  "type": "string",  "usernames": [    "string"  ],  "workflowId": "string"}