SCscrive
Drafts

Create a Flow draft

Creates a new Flow draft. Drafts are instances that can be freely modified until started.

You can provide partial information for the draft when creating it and add the rest later before finally starting it.

The process DSL or process_parameters are not validated when creating the draft.

post/experimental/flow/drafts

Request

Request body

titlestring
folder_idstring

Unique Scrive Folder ID.

Example request

{
  "callback": null,
  "duration": null,
  "folder_id": null,
  "process": {
    "allow-rejections": true,
    "automatic-reminders": [],
    "dsl-version": "0.2.0",
    "stages": [
      {
        "initial-stage": {
          "actions": [
            {
              "notify": {
                "kind": "standard",
                "methods": {
                  "email": "msg1",
                  "email-link-only": null,
                  "sms": "msg2"
                },
                "users": [
                  "user1"
                ]
              }
            }
          ],
          "expect": {
            "signed-by": {
              "documents": [
                "doc1",
                "doc2"
              ],
              "users": [
                "user1"
              ]
            }
          }
        }
      }
    ]
  },
  "process_parameters": null,
  "title": "foobar"
}

Response

idstring uuid required

Unique identifier of the draft.

titlestring
createdstring yyyy-mm-ddThh:MM:ssZ required
author_idstring required

Unique Scrive User ID.

folder_idstring required

Unique Scrive Folder ID.

Example response

{
  "author_id": "321",
  "callback": null,
  "created": "2021-01-27T00:00:00Z",
  "duration": {
    "days": 90,
    "hours": null,
    "minutes": null
  },
  "folder_id": "456",
  "id": "5694310c-08f3-4669-a8b3-351b7d58a36b",
  "process": {
    "allow-rejections": true,
    "automatic-reminders": [],
    "dsl-version": "0.2.0",
    "stages": [
      {
        "initial-stage": {
          "actions": [
            {
              "notify": {
                "kind": "standard",
                "methods": {
                  "email": "msg1",
                  "email-link-only": null,
                  "sms": "msg2"
                },
                "users": [
                  "user1"
                ]
              }
            }
          ],
          "expect": {
            "signed-by": {
              "documents": [
                "doc1",
                "doc2"
              ],
              "users": [
                "user1"
              ]
            }
          }
        }
      }
    ]
  },
  "process_parameters": null,
  "title": "foobar"
}

Changes

No recorded changes to this operation across all 1 revision of this API.