SCscrive
Drafts

Update a Flow draft

Updates the Flow draft.

Setting any optionally nullable field to null will remove if from the draft. Setting the folder_id field will move the draft to that folder.

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

patch/experimental/flow/drafts/{draft_id}

Request

Path parameters

draft_idstring uuid required

Unique identifier of the requested draft.

Request body

titlestring

This is an optionally nullable field. Setting the field to null will remove any previously set value of this field.

folder_idstring

Unique Scrive Folder ID.

Example request

{
  "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": {
    "documents": {
      "doc1": "123"
    },
    "messages": {
      "msg1": "foobar"
    },
    "users": {
      "user1": {
        "auth_to_view": {
          "attempts_per_sms": 1,
          "max_failures": 3,
          "provider": "sms_otp"
        },
        "auth_to_view_archived": null,
        "id": "foo@example.com",
        "id_type": "email"
      }
    }
  },
  "callback": {
    "auth": {
      "password": "password",
      "type": "basic",
      "user": "user"
    },
    "url": "https://www.example.com/",
    "version": 1
  },
  "duration": {
    "days": 15,
    "hours": 7,
    "minutes": 42
  },
  "folder_id": "456"
}

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.