The Adobe Sign Services API follows a microservice architecture that enables Adobe Sign into any part of an application and is built on the JSON API specification, follows predictable REST URLs, and supports cross-origin resource sharing.


The Adobe Sign Services API is installed with the Adobe Sign managed package and can be exposed to external applications via a Salesforce site or community. 



You must replace this path {} with your Salesforce org path.


The Adobe Sign Services API ensures backward compatibility by properly versioning any changes to the APIs. Should changes to the API structure need to be made, it will occur within a new version and older functionality will be preserved.

Content Type

Requests made to the API must be encoded as JSON and contain the header

Content-Type: application/json


You can easily include resource relationships on most top-level resources. Multiple includes are defined using comma-delimited values.


Server side caching is used and can be configured per request using the cacheStrategy query parameter.


Any request that returns an error follows a standard format. The Adobe Sign Services API will return an array of errors that contains objects containing the status, title, and data with the error details.

400Invalid JSON
500Something went wrong on our end
openapi: 3.0.0 info: title: contact: {} version: '1.0' paths: '/agreements/:agreementId/sendForESignature': post: tags: - Adobe Sign Rest API summary: sendForESignature description: Send document for eSignature operationId: sendForESignature parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/Request' example: Recipients: - ContactId: 0032f00000Qg16AAAR OrderNumber: 1 RecipientType: Contact RecipientRole: Signer FileIds: - 0692f000001HdOPAA0 TemplateId: a1p2f0000009wHIAAY required: true responses: '200': description: 'OK' content: application/json: schema: $ref: '#/components/schemas/Response' example: title: success status: 200 data: true deprecated: false components: schemas: Request: title: Request required: - Recipients - FileIds - TemplateId type: object properties: Recipients: type: array items: $ref: '#/components/schemas/Recipient' description: '' FileIds: type: array items: type: string description: '' TemplateId: type: string Recipient: title: Recipient required: - OrderNumber - RecipientType - RecipientRole type: object properties: ContactId: type: string UserId: type: string GroupId: type: string LeadId: type: string EmailAddress: type: string OrderNumber: type: integer format: int32 RecipientType: type: string RecipientRole: type: string RecipientMessage: type: string Response: title: Response required: - title - status - data type: object properties: title: type: string status: type: integer format: int32 data: type: boolean securitySchemes: oauth2: type: oauth2 flows: implicit: authorizationUrl: '' scopes: {} security: - oauth2: []