Schedule deletion of a Partially signed document

DELETE 
/agreements/:agreement_id/documents/partially_signed_documents/:id

Schedule deletion of a Partially signed document

Request

Path Parameters

agreement_id cuidrequired

DELETE /agreements/:agreement_id/documents/partially_signed_documents/:id parameter

id cuidrequired

DELETE /agreements/:agreement_id/documents/partially_signed_documents/:id parameter

Responses

200

DELETE /agreements/:agreement_id/documents/partially_signed_documents/:id Successful response

application/json

Schema

Schema

version stringrequired

Possible values: [1.0]

The version of the response schema

result_type stringrequired

Possible values: [deleted]

Returns a single object of the partially_signed_document resource which was deleted.

resource_type stringrequired

Possible values: [partially_signed_document]

Data contains the partially_signed_document resource.

data objectrequired

The resource data that was deleted.

id cuidrequired

The unique identifier of the partially signed document

resource_type stringrequired

Possible values: [partially_signed_document]

status stringrequired

Possible values: [queued, current, stale, deprecated, failed]

revision int64nullablerequired

Possible values: <= 9007199254740991

file objectnullablerequired

The file resource

id cuidrequired

The unique identifier of the file

resource_type stringrequired

Possible values: [file]

filename stringrequired

Possible values: non-empty

The complete filename including the file extension

mime_type stringrequired

Possible values: non-empty

The mime type of the file

url url

The signed read url of the file

metadata object

lookup_key stringrequired

A provided lookup key provided by you to help you identify the file.

created_at stringrequired

UTC datetime ISO string

updated_at stringrequired

UTC datetime ISO string

delete_scheduled_at stringnullablerequired

UTC datetime ISO string

deleted_at stringnullablerequired

UTC datetime ISO string

deleted booleanrequired

created_at stringrequired

UTC datetime ISO string

updated_at stringrequired

UTC datetime ISO string

Example (from schema)

{
  "version": "1.0",
  "result_type": "deleted",
  "resource_type": "partially_signed_document",
  "data": {
    "id": "cribuzevpjbdmj2psr4example",
    "resource_type": "partially_signed_document",
    "status": "queued",
    "revision": 0,
    "file": {
      "id": "cuf4mt0phzxiwkbzvzpexample",
      "resource_type": "file",
      "filename": "my-file.pdf",
      "mime_type": "application/pdf",
      "url": "https://zigned.se",
      "metadata": {
        "lookup_key": "file_tag"
      },
      "created_at": "2024-01-01T00:00:00.000Z",
      "updated_at": "2024-01-01T00:00:00.000Z"
    },
    "delete_scheduled_at": "2024-01-01T00:00:00.000Z",
    "deleted_at": "2024-01-01T00:00:00.000Z",
    "deleted": true,
    "created_at": "2024-01-01T00:00:00.000Z",
    "updated_at": "2024-01-01T00:00:00.000Z"
  }
}

400

DELETE /agreements/:agreement_id/documents/partially_signed_documents/:id Error response

application/json

Schema

Schema

status stringrequired

Possible values: [error]

error objectrequired
code int64required
Possible values: >= 400 and <= 599
message stringrequired
request_id uuidrequired

Example (from schema)

{
  "status": "error",
  "error": {
    "code": 0,
    "message": "string",
    "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

Loading...