The Signing Attachment object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

signing_document_id string required
label string required
attachment_type string

Default: link

data string required
The Signing Attachment object 
{
  "id": "signing-attachment_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "signing_document_id": "signing_document_id_example",
  "label": "label_example",
  "attachment_type": "link",
  "data": "data_example"
}
GET /api/signing/signing-attachment/{id}

Retrieve a signing attachment

Retrieves the details of an existing signing attachment. Supply the unique signing attachment ID that was returned from a previous request.

Path parameters

id string required

The identifier of the signing attachment to retrieve.

Returns

Returns the signing attachment object if a valid identifier was provided.

GET /api/signing/signing-attachment/{id} 
curl https://api.overplane.dev/api/signing/signing-attachment/signing-attachment_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "signing-attachment_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "signing_document_id": "signing_document_id_example",
  "label": "label_example",
  "attachment_type": "link",
  "data": "data_example"
}
GET /api/signing/signing-attachment

List all signing attachments

Returns a list of signing attachments. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of signing attachment objects.

GET /api/signing/signing-attachment 
curl https://api.overplane.dev/api/signing/signing-attachment \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "signing-attachment_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "signing_document_id": "signing_document_id_example",
      "label": "label_example",
      "attachment_type": "link",
      "data": "data_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/signing/signing-attachment

Create a signing attachment

Creates a new signing attachment object.

Body parameters

signing_document_id string required
label string required
attachment_type string

Default: link

data string required

Returns

Returns the newly created signing attachment object if the call succeeded.

POST /api/signing/signing-attachment 
curl https://api.overplane.dev/api/signing/signing-attachment \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"signing_document_id":"signing_document_id_example","label":"label_example","data":"data_example"}'
Response 
{
  "id": "signing-attachment_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "signing_document_id": "signing_document_id_example",
  "label": "label_example",
  "attachment_type": "link",
  "data": "data_example"
}
PATCH /api/signing/signing-attachment/{id}

Update a signing attachment

Updates the specified signing attachment by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the signing attachment to update.

Body parameters

signing_document_id string
label string
attachment_type string

Default: link

data string

Returns

Returns the updated signing attachment object.

PATCH /api/signing/signing-attachment/{id} 
curl https://api.overplane.dev/api/signing/signing-attachment/signing-attachment_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"signing_document_id":"signing_document_id_example","label":"label_example"}'
Response 
{
  "id": "signing-attachment_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "signing_document_id": "signing_document_id_example",
  "label": "label_example",
  "attachment_type": "link",
  "data": "data_example"
}
DELETE /api/signing/signing-attachment/{id}

Delete a signing attachment

Permanently deletes a signing attachment. This cannot be undone.

Path parameters

id string required

The identifier of the signing attachment to delete.

Returns

Returns a confirmation that the signing attachment has been deleted.

DELETE /api/signing/signing-attachment/{id} 
curl https://api.overplane.dev/api/signing/signing-attachment/signing-attachment_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "signing-attachment_abc123",
  "deleted": true
}