The Signing Share Link 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
email string required
slug string required
The Signing Share Link object 
{
  "id": "signing-share-link_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "signing_document_id": "signing_document_id_example",
  "email": "user@example.com",
  "slug": "slug_example"
}
GET /api/signing/signing-share-link/{id}

Retrieve a signing share link

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

Path parameters

id string required

The identifier of the signing share link to retrieve.

Returns

Returns the signing share link object if a valid identifier was provided.

GET /api/signing/signing-share-link/{id} 
curl https://api.overplane.dev/api/signing/signing-share-link/signing-share-link_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "signing-share-link_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "signing_document_id": "signing_document_id_example",
  "email": "user@example.com",
  "slug": "slug_example"
}
GET /api/signing/signing-share-link

List all signing share links

Returns a list of signing share links. 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 share link objects.

GET /api/signing/signing-share-link 
curl https://api.overplane.dev/api/signing/signing-share-link \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "signing-share-link_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "signing_document_id": "signing_document_id_example",
      "email": "user@example.com",
      "slug": "slug_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/signing/signing-share-link

Create a signing share link

Creates a new signing share link object.

Body parameters

signing_document_id string required
email string required
slug string required

Returns

Returns the newly created signing share link object if the call succeeded.

POST /api/signing/signing-share-link 
curl https://api.overplane.dev/api/signing/signing-share-link \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"signing_document_id":"signing_document_id_example","email":"user@example.com","slug":"slug_example"}'
Response 
{
  "id": "signing-share-link_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "signing_document_id": "signing_document_id_example",
  "email": "user@example.com",
  "slug": "slug_example"
}
PATCH /api/signing/signing-share-link/{id}

Update a signing share link

Updates the specified signing share link 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 share link to update.

Body parameters

signing_document_id string
email string
slug string

Returns

Returns the updated signing share link object.

PATCH /api/signing/signing-share-link/{id} 
curl https://api.overplane.dev/api/signing/signing-share-link/signing-share-link_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"signing_document_id":"signing_document_id_example","email":"user@example.com"}'
Response 
{
  "id": "signing-share-link_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "signing_document_id": "signing_document_id_example",
  "email": "user@example.com",
  "slug": "slug_example"
}
DELETE /api/signing/signing-share-link/{id}

Delete a signing share link

Permanently deletes a signing share link. This cannot be undone.

Path parameters

id string required

The identifier of the signing share link to delete.

Returns

Returns a confirmation that the signing share link has been deleted.

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