The Signing Settings 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.

company string required

typed_signature_enabled boolean

Default: true

draw_signature_enabled boolean

Default: true

upload_signature_enabled boolean

Default: true

default_auth_options string

from_email string

from_name string

logo_url string

brand_color string

default_signing_order string

Default: parallel

default_date_format string

Default: yyyy-MM-dd hh:mm a

default_timezone string

Default: Etc/UTC

default_language string

Default: en

default_expiry_days integer

default_redirect_url string

default_reminder_settings string

The Signing Settings object

{
  "id": "signing-settings_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "company": "Example Corp",
  "typed_signature_enabled": true,
  "draw_signature_enabled": true,
  "upload_signature_enabled": true,
  "default_auth_options": "default_auth_options_example",
  "from_email": "[email protected]",
  "from_name": "from_name_example",
  "logo_url": "logo_url_example",
  "brand_color": "brand_color_example",
  "default_signing_order": "parallel",
  "default_date_format": "yyyy-MM-dd hh:mm a",
  "default_timezone": "Etc/UTC",
  "default_language": "en",
  "default_expiry_days": 0,
  "default_redirect_url": "default_redirect_url_example",
  "default_reminder_settings": "default_reminder_settings_example"
}

GET /api/signing/signing-settings/{id}

Retrieve a signing settings

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

Path parameters

id string required

The identifier of the signing settings to retrieve.

Returns

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

GET /api/signing/signing-settings/{id}

curl https://api.overplane.dev/api/signing/signing-settings/signing-settings_abc123 \
  -H "Authorization: Bearer sk_test_..."

Response

{
  "id": "signing-settings_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "company": "Example Corp",
  "typed_signature_enabled": true,
  "draw_signature_enabled": true,
  "upload_signature_enabled": true,
  "default_auth_options": "default_auth_options_example",
  "from_email": "[email protected]",
  "from_name": "from_name_example",
  "logo_url": "logo_url_example",
  "brand_color": "brand_color_example",
  "default_signing_order": "parallel",
  "default_date_format": "yyyy-MM-dd hh:mm a",
  "default_timezone": "Etc/UTC",
  "default_language": "en",
  "default_expiry_days": 0,
  "default_redirect_url": "default_redirect_url_example",
  "default_reminder_settings": "default_reminder_settings_example"
}

GET /api/signing/signing-settings

List all signing settingss

Returns a list of signing settingss. 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 settings objects.

GET /api/signing/signing-settings

curl https://api.overplane.dev/api/signing/signing-settings \
  -H "Authorization: Bearer sk_test_..."

Response

{
  "data": [
    {
      "id": "signing-settings_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "company": "Example Corp",
      "typed_signature_enabled": true,
      "draw_signature_enabled": true,
      "upload_signature_enabled": true,
      "default_auth_options": "default_auth_options_example",
      "from_email": "[email protected]",
      "from_name": "from_name_example",
      "logo_url": "logo_url_example",
      "brand_color": "brand_color_example",
      "default_signing_order": "parallel",
      "default_date_format": "yyyy-MM-dd hh:mm a",
      "default_timezone": "Etc/UTC",
      "default_language": "en",
      "default_expiry_days": 0,
      "default_redirect_url": "default_redirect_url_example",
      "default_reminder_settings": "default_reminder_settings_example"
    }
  ],
  "has_more": false,
  "total": 1
}

POST /api/signing/signing-settings

Create a signing settings

Creates a new signing settings object.

Body parameters

company string required

typed_signature_enabled boolean

Default: true

draw_signature_enabled boolean

Default: true

upload_signature_enabled boolean

Default: true

default_auth_options string

from_email string

from_name string

logo_url string

brand_color string

default_signing_order string

Default: parallel

default_date_format string

Default: yyyy-MM-dd hh:mm a

default_timezone string

Default: Etc/UTC

default_language string

Default: en

default_expiry_days integer

default_redirect_url string

default_reminder_settings string

Returns

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

POST /api/signing/signing-settings

curl https://api.overplane.dev/api/signing/signing-settings \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"company":"Example Corp"}'

Response

{
  "id": "signing-settings_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "company": "Example Corp",
  "typed_signature_enabled": true,
  "draw_signature_enabled": true,
  "upload_signature_enabled": true,
  "default_auth_options": "default_auth_options_example",
  "from_email": "[email protected]",
  "from_name": "from_name_example",
  "logo_url": "logo_url_example",
  "brand_color": "brand_color_example",
  "default_signing_order": "parallel",
  "default_date_format": "yyyy-MM-dd hh:mm a",
  "default_timezone": "Etc/UTC",
  "default_language": "en",
  "default_expiry_days": 0,
  "default_redirect_url": "default_redirect_url_example",
  "default_reminder_settings": "default_reminder_settings_example"
}

PATCH /api/signing/signing-settings/{id}

Update a signing settings

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

Body parameters

company string

typed_signature_enabled boolean

Default: true

draw_signature_enabled boolean

Default: true

upload_signature_enabled boolean

Default: true

default_auth_options string

from_email string

from_name string

logo_url string

brand_color string

default_signing_order string

Default: parallel

default_date_format string

Default: yyyy-MM-dd hh:mm a

default_timezone string

Default: Etc/UTC

default_language string

Default: en

default_expiry_days integer

default_redirect_url string

default_reminder_settings string

Returns

Returns the updated signing settings object.

PATCH /api/signing/signing-settings/{id}

curl https://api.overplane.dev/api/signing/signing-settings/signing-settings_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"company":"Example Corp","typed_signature_enabled":true}'

Response

{
  "id": "signing-settings_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "company": "Example Corp",
  "typed_signature_enabled": true,
  "draw_signature_enabled": true,
  "upload_signature_enabled": true,
  "default_auth_options": "default_auth_options_example",
  "from_email": "[email protected]",
  "from_name": "from_name_example",
  "logo_url": "logo_url_example",
  "brand_color": "brand_color_example",
  "default_signing_order": "parallel",
  "default_date_format": "yyyy-MM-dd hh:mm a",
  "default_timezone": "Etc/UTC",
  "default_language": "en",
  "default_expiry_days": 0,
  "default_redirect_url": "default_redirect_url_example",
  "default_reminder_settings": "default_reminder_settings_example"
}

DELETE /api/signing/signing-settings/{id}

Delete a signing settings

Permanently deletes a signing settings. This cannot be undone.

Path parameters

id string required

The identifier of the signing settings to delete.

Returns

Returns a confirmation that the signing settings has been deleted.

DELETE /api/signing/signing-settings/{id}

curl https://api.overplane.dev/api/signing/signing-settings/signing-settings_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE

Response

{
  "id": "signing-settings_abc123",
  "deleted": true
}

The Signing Settings object

Attributes

Retrieve a signing settings

Path parameters

Returns

List all signing settingss

Query parameters

Returns

Create a signing settings

Body parameters

Returns

Update a signing settings

Path parameters

Body parameters

Returns

Delete a signing settings

Path parameters

Returns

Coming Soon