Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

YouSign Custom Property API

A configurable field (list or text) allowing to tag Signature Requests with structured values.

YouSign Custom Property API is one of 38 APIs that YouSign publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Custom Property. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a changelog, rate-limit docs, and 1 JSON Schema.

This API exposes 5 operations across 2 paths, and defines 16 schemas. It is described by OpenAPI 3.0.0, at version 3.0.

Requests are made against 2 base URLs: https://api-sandbox.yousign.app/v3, https://api.yousign.app/v3.

5 operations 2 paths 16 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
3.0
Base URL
https://api.yousign.com/v3
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

YouSign Custom Property API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Custom Property 5

A configurable field (list or text) allowing to tag Signature Requests with structured values.

GET
/custom_properties
List Custom Properties
get-custom_properties 4 params → 200400401403405429500
POST
/custom_properties
Create a Custom Property
post-custom_properties body → 201400401403404405429500
DELETE
/custom_properties/{customPropertyId}
Delete a Custom Property
delete-custom_properties-id 1 param → 204400401403404405429500
GET
/custom_properties/{customPropertyId}
Get a Custom Property
get-custom_properties-id 1 param → 200400401403404405429500
PATCH
/custom_properties/{customPropertyId}
Update a Custom Property
patch-custom_properties-id 1 param body → 200400401403404405429500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are CustomProperty (10 properties), CreateCustomProperty (6 properties), UpdateCustomProperty (6 properties), CustomPropertyOption (4 properties). Each schema is shown below with its type and property counts.

InternalServerError
object
2 properties 2 required
CustomPropertyType
string
CustomProperty
object
10 properties 5 required
TooManyRequestsResponse
object
1 property 1 required
CreateCustomProperty
object
6 properties 2 required
CustomPropertyOptionUpdate
object
4 properties 1 required
CustomPropertyList
object
2 properties 1 required
UpdateCustomProperty
object
6 properties
MethodNotAllowed
object
1 property 1 required
NotFoundResponse
object
2 properties 2 required
BadRequestResponse
object
2 properties 2 required
ForbiddenResponse
object
2 properties 2 required
UnauthorizedResponse
object
2 properties 2 required
UUID
string
The unique identifier for a resource.
CustomPropertyOptionInput
object
3 properties 1 required
CustomPropertyOption
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yousign-custom-property-api-openapi.yml Raw ↑

Other APIs YouSign publishes across the network.

YouSign Applicant API
YouSign Approver API
YouSign Archive API
YouSign Audit Trail API
YouSign Bank Account Lookup Verification API
YouSign Bank Account Verification API
YouSign Company Verification API
YouSign Consumption API
YouSign Contact API
YouSign Custom Experience API
YouSign Deprecated API
YouSign Document Analysis API