Adobe Acrobat Sign Component

Adobe Acrobat Sign is an e-signature management solution. Use the Adobe Acrobat Sign component to send, sign, track, and manage the signature process.

Component key: adobe-acrobat-sign

Description

Adobe Acrobat Sign is an e-signature management solution.

Use the Adobe Acrobat Sign component to send, sign, track, and manage the signature process.

API Documentation

This component was built using the Adobe Sign REST API v6.

Connections

OAuth 2.0

To configure OAuth for Sign, begin by creating an App:

Log in to Acrobat Sign.
Select API from the top menu. If you do not see the API link, select Account
Select API Applications.
Select the Create (+) icon at the top right of the table and provide details about your app.
Choose a domain based on the intended use:
CUSTOMER: Apps that only access your account or are used for internal use and testing.
PARTNER: Select this type if you're developing an application for other users and your app needs access to other Acrobat Sign accounts. Note: PARTNER applications must be certified to have full access to other accounts.

To Retrieve the OAuth Client ID and Secret:

In the API Applications menu, select the application.
Click Configure OAuth for the Application link to configure your OAuth integration.
For the redirect URI enter https://oauth2.prismatic.io/callback.
check the boxes for the necessary scopes needed with the modifier set to account for the integration and save.
in the API Applications menu, select the application and select View / Edit.
Enter the Application ID/Client ID and Client Secret Values into the connection configuration of the integration.
Client ID and Application ID are the same value and can be used interchangeably.
Enter the scopes

Input	Default	Notes
Authorize URL string / Required authorizeUrl	https://secure.na3.adobesign.com/public/oauth/v2	The OAuth 2.0 Authorization URL for Acrobat Sign with the correct region/shard (this can be found in the URL when you are logged into the Adobe Sign web app). For example, if the URL is https://secure.na3.adobesign.com, the authorize URL would be 'https://secure.na3.adobesign.com/public/oauth/v2'
Client ID string / Required clientId		Client Identifier of your Acrobat Sign App (shown as Application ID inside Acrobat Sign)
Client Secret password / Required clientSecret		Client Secret of your Acrobat Sign App
Refresh URL string / Required refreshUrl	https://secure.na3.adobesign.com/oauth/v2/refresh	The OAuth 2.0 Refresh URL for Acrobat Sign with the correct region/shard (this can be found in the URL when you are logged into the Adobe Sign web app). For example, if the URL is https://secure.na3.adobesign.com, the token URL would be 'https://secure.na3.adobesign.com/oauth/v2/refresh)
Scopes string scopes	user_read:account user_write:self agreement_read:group	Space separated OAuth 2.0 permission scopes for Acrobat Sign. Add scope modifiers using colons. https://opensource.adobe.com/acrobat-sign/developer_guide/gstarted.html#configure-scopes
Token URL string / Required tokenUrl	https://secure.na3.adobesign.com/oauth/v2/token	The OAuth 2.0 Token URL for Acrobat Sign with the correct region/shard (this can be found in the URL when you are logged into the Adobe Sign web app). For example, if the URL is https://secure.na3.adobesign.com, the token URL would be 'https://secure.na3.adobesign.com/oauth/v2/token)

Triggers

Webhook

Receive and validate webhook requests from Adobe Sign for webhooks you configure. | key: adobeSignTrigger

Input	Notes
Connection connection / Required connection

Data Sources

Select Agreements

A picklist of all agreements under this account, separated byName - Display Date | key: selectAgreements | type: picklist

Input	Notes
Connection connection / Required connection

Select Group

A picklist of all Acrobat Sign groups under this account. | key: selectGroup | type: picklist

Input	Notes
Connection connection / Required connection

Select Users

A picklist of all Acrobat Sign users under this account. | key: selectUsers | type: picklist

Input	Notes
Connection connection / Required connection

Actions

Create Account

Creates an Acrobat Sign account under the partner channel. | key: createAccount

Input	Default	Notes
Account Type string / Required accountType		The type of account to be created.
Company string company		The company of the user.
Connection connection / Required connection
Country Code string / Required countryCode		The country code of the account.
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Email string / Required email		The email address of the user to be created.
External ID string externalId		Case-sensitive External ID for which you would like to retrieve agreement information. ExternalId is passed in the call to the agreement creation API. (Note: the externalId value is visible to all participants through the API, so should not be used to contain a sensitive token)
First Name string / Required firstName		The first name of the user.
Last Name string / Required lastName		The last name of the user.
Locale string locale		The locale of the user.
Number of Seats string / Required numSeats		The number of seats.
Phone string phone		The phone number of the user.
Title string title		The job title of the user.
Trial Duration Days string trialDuration		Account trial duration (in days).

Example Payload for Create Account

{
  "adminUserInfo": {
    "email": "prismatic@test.com",
    "firstName": "Prismatic",
    "lastName": "Test",
    "locale": "en_US",
    "phone": "555-555-5555",
    "title": "Software Engineer"
  },
  "accountType": "FREE",
  "countryCode": "US",
  "numSeats": 1,
  "company": "Prismatic",
  "externalId": "1234",
  "locale": "en_US",
  "trialDuration": 30
}

Create Agreement

Creates an agreement. Sends it out for signatures and returns the agreementId in the response to the client. | key: createAgreement

Input	Default	Notes
Agreement Name string / Required agreementName		Name of the Agreement that will be used to identify it.
Agreement State string agreementState		State of the agreement.
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Participant Member Info Email string / Required participantMemberInfoEmail		Email address of the participant.
Participant Set Info Role string / Required participantsSetInfoRole		Role assumed by all participants in this set (signer, approver, etc.)
Signature Type string signatureType		The type of signature you would like to request - written or e-signature.
Transient Document ID string / Required transientDocumentId		ID for a transient document that will be added to the agreement.

Example Payload for Create Agreement

{
  "fileInfos": [
    {
      "transientDocumentId": "3AAABLblqZhBf0aJb0XZqz5vXy8g3V9R3qQx6..."
    }
  ],
  "name": "Test Agreement",
  "signatureType": "ESIGN",
  "state": "IN_PROCESS",
  "participantSetsInfo": [
    {
      "order": 1,
      "role": "SIGNER",
      "memberInfos": [
        {
          "email": "prismatic@test.com"
        }
      ]
    }
  ]
}

Create Group

Creates a new group in an account. | key: createGroup

Input	Default	Notes	Example
Connection connection / Required connection
Created string / Required created		Date of creation of the group. Format would be yyyy-MM-dd'T'HH:mm:ssZ	2016-02-25T18:46:19Z
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Group Name string / Required groupName		The name of the group.	My Group
Is Default Group string isDefaultGroup		true if the group is default group.

Example Payload for Create Group

{
  "data": {
    "id": "CBJCHBCAABAAIYEoZ3VPDavcqvJm3ni7ATNn-O9N3OPf"
  }
}

Create Transient Document

Uploads a document and obtains the document's ID. | key: createTransientDocument

Input	Default	Notes
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
File data / Required file		The file part of the multipart request for document upload. You can upload only one file at a time.
File Name string / Required fileName		A name for the document being uploaded. Maximum number of characters in the name is restricted to 255.
Mime Type string mimeType		The mime type of the document being uploaded. If not specified here then mime type is picked up from the file object. If mime type is not present there either then mime type is inferred from the file extension.

Example Payload for Create Transient Document

{
  "file": {
    "data": "<10000 bytes>"
  },
  "fileName": "Test Document.pdf",
  "mimeType": "application/pdf"
}

Create User

Creates a new user in the Acrobat Sign system. | key: createUser

Input	Default	Notes
Account ID string accountId		The account id of the user.
Company string company		The company of the user.
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Email string / Required email		The email address of the user to be created.
First Name string firstName		The first name of the user.
Initials string initials		The initials of the user.
Account Admin boolean / Required isAccountAdmin	false	true if the user is account admin.
Last Name string lastName		The last name of the user.
Locale string locale		The locale of the user.
Phone string phone		The phone number of the user.
Title string title		The job title of the user.

Example Payload for Create User

{
  "email": "prismatic@test.com",
  "isAccountAdmin": true,
  "accountId": "someId",
  "company": "Prismatic",
  "firstName": "Prismatic",
  "initials": "Prism",
  "lastName": "Test",
  "locale": "en_US",
  "phone": "555-555-5555",
  "title": "Software Engineer"
}

Create Webhook

Creates a webhook. | key: createWebhook

Input	Default	Notes
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Scope string / Required scope		Scope of the webhook
Webhook Agreement Conditional Parameters string Value List webhookAgreementEvents		Conditions which webhook creator can specify for the payload while creating or updating a webhook.
Application Display Name string webhookApplicationDisplayName		The name of the application through which the webhook is created
Application Name string webhookApplicationName		The name of the application through which the webhook is created
Webhook Library Documents Conditional Parameters string Value List webhookLibraryDocumentEvents		Conditions which webhook creator can specify for the payload while creating or updating a webhook.
Webhook MegaSign Conditional Parameters string Value List webhookMegaSignEvents		Conditions which webhook creator can specify for the payload while creating or updating a webhook.
Webhook Name string / Required webhookName		The name of the webhook.
Problem Notification Emails string Value List webhookProblemNotificationEmails		The list of email addresses to which the webhook problem is to be notified.
Resource ID string webhookResourceId		Id of the resource type for which you want to create webhook. Provide agreementId if webhook needs to be created for an agreement. Similarly, widgetId if webhook needs to be created for a web form,megaSignId if webhook needs to be created for a bulk send and libraryDocumentId if webhook needs to be created for a library document. NOTE: Need to specify only if scope is 'RESOURCE'.
Webhook Resource Type string webhookResourceType		The type of resource being accessed. (Note: need to specify this only if scope is Resource).
Webhook Subscription Events string / Required Value List webhookSubscriptionEvents		The list of events for which the webhook subscription is being made.
Webhook URL string / Required webhookUrlInfo		The URL to which the webhook payload is to be delivered.
Webhook Widget Conditional Parameters string Value List webhookWidgetEvents		Conditions which webhook creator can specify for the payload while creating or updating a webhook.

Example Payload for Create Webhook

{
  "name": "Test Webhook",
  "scope": "ACCOUNT",
  "state": "ACTIVE",
  "webhookUrlInfo": {
    "url": "<Your Integration trigger url here>"
  },
  "webhookSubscriptionEvents": [
    "AGREEMENT_ALL"
  ],
  "webhookConditionalParams": {
    "webhookAgreementEvents": {
      "includeDetailedInfo": true,
      "includeDocumentsInfo": true,
      "includeParticipantsInfo": true,
      "includeSignedDocuments": true
    }
  }
}

Delete Agreement Documents

Deletes all the documents for an agreement. | key: deleteAgreementDocuments

Input	Default	Notes
Agreement ID string agreementId		The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. If provided
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.

Delete Group

Delete an existing group. | key: deleteGroup

Input	Default	Notes
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Group ID string / Required groupId		The unique identifier of the group.

Example Payload for Delete Group

{
  "data": {}
}

Delete Webhook

Deletes a webhook. | key: deleteWebhook

Input	Default	Notes
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Webhook ID string / Required webhookId		The webhook identifier, as returned by the Adobe Sign Webhook API.

Download Agreement PDF

Downloads the PDF associated with an agreement. | key: downloadAgreementFile

Input	Default	Notes
Agreement ID string / Required agreementId		The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. If provided
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.

Get Account

Retrieves the information for an account. | key: getAccount

Input	Default	Notes
Account ID string accountId		The account id of the user.
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.

Get Agreement

Retrieves the current status of an agreement. | key: getAgreement

Input	Default	Notes
Agreement ID string agreementId		The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. If provided
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.

Get Group

Retrieves detailed information about the group. | key: getGroup

Input	Default	Notes
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Group ID string / Required groupId		The unique identifier of the group.

Example Payload for Get Group

{
  "data": {
    "groupId": "CBJCHBCAABAAIYEoZ3VPDavcqvJm3ni7ATNn-O9N3OPf",
    "createdDate": "2023-12-06T22:02:50Z",
    "groupName": "Default Group",
    "isDefaultGroup": true
  }
}

Get User

Retrieves detailed information about the user in the caller account. | key: getUser

Input	Default	Notes
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
User ID string / Required userId		The user identifier, as returned by the user creation API or retrieved from the API to fetch users. If provided

Get Webhook

Retrieves the details of a webhook. | key: getWebhook

Input	Default	Notes
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Webhook ID string / Required webhookId		The webhook identifier, as returned by the Adobe Sign Webhook API.

List Agreements

Retrieves agreements for the user. | key: listAgreements

Input	Default	Notes
Connection connection / Required connection
Cursor string cursor		Used to navigate through pagination. If not provided, it will default to the first page.
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
External ID string externalId		Case-sensitive External ID for which you would like to retrieve agreement information. ExternalId is passed in the call to the agreement creation API. (Note: the externalId value is visible to all participants through the API, so should not be used to contain a sensitive token)
Group ID string groupId		The group identifier, as returned by the group creation API or retrieved from the API to fetch groups. If provided
Page Size string pageSize		The number of results to return per page. If not provided, it is decided by your application settings.
Show Hidden Agreements boolean showHiddenAgreements	false	A query parameter to fetch all the hidden agreements along with the visible agreements. Default value is false.

List Group Events

Retrieves all events for group | key: listGroupEvents

Input	Default	Notes
Connection connection / Required connection
Cursor string cursor		Used to navigate through pagination. If not provided, it will default to the first page.
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Group ID string / Required groupId		The unique identifier of the group.
Page Size string pageSize		The number of results to return per page. If not provided, it is decided by your application settings.

Example Payload for List Group Events

{
  "data": [
    {
      "groupEventId": "CBJCHBCAABAA82chKH_73ytJxSou5uTTrIh7rRelwSro",
      "date": "2023-12-06T22:02:49Z",
      "event": "CREATED",
      "accountId": "CBJCHBCAABAAd4TPldfK4H2cTTDlWxJ6i4JDiVDoOC2C",
      "groupId": "CBJCHBCAABAAIYEoZ3VPDavcqvJm3ni7ATNn-O9N3OPf"
    },
    {
      "groupEventId": "CBJCHBCAABAA82chKH_73ytJxSou5uTTrIh7rRelwSro",
      "date": "2023-12-06T22:02:49Z",
      "event": "CREATED",
      "accountId": "CBJCHBCAABAAd4TPldfK4H2cTTDlWxJ6i4JDiVDoOC2C",
      "groupId": "CBJCHBCAABAAIYEoZ3VPDavcqvJm3ni7ATNn-O9N3OPf"
    }
  ]
}

List Group Users

Retrieves all the users in a group. | key: listGroupUsers

Input	Default	Notes
Connection connection / Required connection
Cursor string cursor		Used to navigate through pagination. If not provided, it will default to the first page.
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Group ID string / Required groupId		The unique identifier of the group.
Page Size string pageSize		The number of results to return per page. If not provided, it is decided by your application settings.

Example Payload for List Group Users

{
  "data": [
    {
      "email": "components@prismatic.io",
      "company": "Prismatic",
      "id": "CBJCHBCAABAApRvVMBVyo0bIo4jdPROKiKWR9xRhRugJ",
      "firstName": "Thomas",
      "lastName": "Tedrow",
      "isGroupAdmin": false
    },
    {
      "email": "components@prismatic.io",
      "company": "Prismatic",
      "id": "CBJCHBCAABAApRvVMBVyo0bIo4jdPROKiKWR9xRhRugJ",
      "firstName": "Thomas",
      "lastName": "Tedrow",
      "isGroupAdmin": false
    }
  ]
}

List Groups

Retrieve a list of groups in the Adobe Sign account. | key: listGroups

Input	Default	Notes
Connection connection / Required connection
Cursor string cursor		Used to navigate through pagination. If not provided, it will default to the first page.
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Page Size string pageSize		The number of results to return per page. If not provided, it is decided by your application settings.

Example Payload for List Groups

{
  "data": [
    {
      "groupId": "CBJCHBCAABAAIYEoZ3VPDavcqvJm3ni7ATNn-O9N3OPf",
      "createdDate": "2023-12-06T22:02:50Z",
      "groupName": "Default Group",
      "isDefaultGroup": true
    },
    {
      "groupId": "CBJCHBCAABAAIYEoZ3VPDavcqvJm3ni7ATNn-O9N3OPf",
      "createdDate": "2023-12-06T22:02:50Z",
      "groupName": "Default Group",
      "isDefaultGroup": true
    }
  ]
}

List Users

Retrieves all the users in an account. | key: listUsers

Input	Default	Notes
Connection connection / Required connection
Cursor string cursor		Used to navigate through pagination. If not provided, it will default to the first page.
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Page Size string pageSize		The number of results to return per page. If not provided, it is decided by your application settings.

List Webhooks

Retrieves webhooks for a user. | key: listWebhooks

Input	Default	Notes
Connection connection / Required connection
Cursor string cursor		Used to navigate through pagination. If not provided, it will default to the first page.
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Page Size string pageSize		The number of results to return per page. If not provided, it is decided by your application settings.
Scope string scope		Filter for webhooks with a specific scope.
Show Inactive Webhooks boolean showInactiveWebhooks	false	A query parameter to fetch all the inactive webhooks along with theactive webhooks. Default value is false.
Webhook Resource Type string webhookResourceType		The type of resource being accessed. (Note: need to specify this only if scope is Resource).

Raw Request

Send raw HTTP request to Adobe Acrobat Sign | key: rawRequest

Input	Default	Notes	Example
Connection connection / Required connection
Data string data		The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
File Data string Key Value List fileData		File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names string Key Value List fileDataFileNames		File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data string Key Value List formData		The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header string Key Value List headers		A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count string maxRetries	0	The maximum number of retries to attempt. Specify 0 for no retries.
Method string / Required method		The HTTP method to use.
Query Parameter string Key Value List queryParams		A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Response Type string / Required responseType	json	The type of data you expect in the response. You can request json, text, or binary data.
Retry On All Errors boolean retryAllErrors	false	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.
Retry Delay (ms) string retryDelayMS	0	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.
Timeout string timeout		The maximum time that a client will await a response to its request	2000
URL string / Required url		Input the path only (/agreements), The base URL is already included. For example, in order to send a agreements request, only /agreements is entered in this field.	/agreements
Use Exponential Backoff boolean useExponentialBackoff	false	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

Search Resources

Retrieves, searches, filters and sorts agreements for the user | key: searchResources

Input	Default	Notes
Asset ID(s) string Value List assetId		A filter against case-sensitive agreement asset id for which you would like to retrieve the information.
Connection connection / Required connection
Created Greater Than Date string dateGreaterThanCreatedDate		The maximum allowed date-time that is allowed in the result set. Values for each range field must adhere to the ISO-8601 standard.Range terms can be defined as less-than/greater-than or min/max.If terms are mixed the JSON will be considered malformed.
Expiration Greater Than Date string dateGreaterThanExpirationDate		The maximum allowed date-time that is allowed in the result set. Values for each range field must adhere to the ISO-8601 standard.Range terms can be defined as less-than/greater-than or min/max.If terms are mixed the JSON will be considered malformed.
Modified Greater Than Date string dateGreaterThanModifiedDate		The minimum allowed date-time that is allowed in the result set. Values for each range field must adhere to the ISO-8601 standard.
Created Less Than Date string dateLessThanCreatedDate		The maximum allowed date-time that is allowed in the result set. Values for each range field must adhere to the ISO-8601 standard.Range terms can be defined as less-than/greater-than or min/max.If terms are mixed the JSON will be considered malformed.
Expiration Less Than Date string dateLessThanExpirationDate		The maximum allowed date-time that is allowed in the result set. Values for each range field must adhere to the ISO-8601 standard.Range terms can be defined as less-than/greater-than or min/max.If terms are mixed the JSON will be considered malformed.
Modified Less Than Date string dateLessThanModifiedDate		The minimum allowed date-time that is allowed in the result set. Values for each range field must adhere to the ISO-8601 standard.
Created Max Date string dateMaxCreatedDate		The maximum allowed date-time that is allowed in the result set. Values for each range field must adhere to the ISO-8601 standard.Range terms can be defined as less-than/greater-than or min/max.If terms are mixed the JSON will be considered malformed.
Expiration Max Date string dateMaxExpirationDate		The maximum allowed date-time that is allowed in the result set. Values for each range field must adhere to the ISO-8601 standard.Range terms can be defined as less-than/greater-than or min/max.If terms are mixed the JSON will be considered malformed.
Modified Max Date string dateMaxModifiedDate		The minimum allowed date-time that is allowed in the result set. Values for each range field must adhere to the ISO-8601 standard.
Created Min Date string dateMinCreatedDate		The minimum allowed date-time that is allowed in the result set. Values for each range field must adhere to the ISO-8601 standard.Range terms can be defined as less-than/greater-than or min/max.
Expiration Min Date string dateMinExpirationDate		The maximum allowed date-time that is allowed in the result set. Values for each range field must adhere to the ISO-8601 standard.Range terms can be defined as less-than/greater-than or min/max.If terms are mixed the JSON will be considered malformed.
Modified Min Date string dateMinModifiedDate		The minimum allowed date-time that is allowed in the result set. Values for each range field must adhere to the ISO-8601 standard.
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
External ID string Value List externalId		A filter against case-sensitive external id for which you would like to retrieve agreement asset information. External id is passedin the call to the agreement asset creation API. Supply them in acomma-separated manner.
Group ID string Value List groupId		A filter against group identifier(s), as returned by the group creation API or retrieved from the API to fetch groups.
Library Document ID string libraryDocumentId		A filter against case-sensitive library document id that was usedto create an agreement. This filter will only apply for the sender of theagreement since signers don't have the knowledge of how the agreement wascreated. Also, this filter only applies to library documents with type DOCUMENT but not FORM_FIELD_LAYER
Ownership Scope string / Required ownershipScope		Ownership scope of the agreement documents to include in this search request. Default is 'OWNED'.
Page Size string pageSize		The number of results to return per page. If not provided, it is decided by your application settings.
Parent ID string Value List parentId		A filter against case-sensitive parent id for which you would like to retrieve agreement asset information.
Participant Email string Value List participantEmail		A filter against participant emails for which you would like to retrieve agreement asset information.
Queryable Fields string Value List queryableFields		A list of field names against which string query specified in the 'query' field above is executed. For more information, please refer here: https://helpx.adobe.com/sign/using/adobesign-search-users-agreements.html#NamePrefix
Query string searchQuery		This field provides text search capibility against termsin the field values of agreements that are visibile to the usermaking the request. To find more about how text searching works please refer here: https://helpx.adobe.com/sign/using/adobesign-search-users-agreements.html#HowSearchWorks
Role string Value List searchRole		A filter against the roles the user has on agreement assets
Status string Value List searchStatus		A filter against the detailed status of the agreement asset.PLEASE note that PARTIAL and DRAFT agreements are not supported for search
Type string searchType		A filter against the agreement asset type.
User ID string Value List searchUserId		A filter against the user for account sharing. (Comma-separated)
Workflow ID string Value List searchWorkflowId		A filter against case-sensitive workflow id for which you wouldlike to retrieve agreement asset information. Workflow id is passed in the call to the agreement asset creation API.
Sort By Field string sortByField		Defines the field by which the results will be ordered
Sort Order string sortOrder		Sets the direction of the order
Start Index string startIndex		0-based first row (offset) of the search results to return. The value must be greater than or equal to 0 and less than 10000. If not provided, the default value is 0 and returns results from the very first row, without offset
Sub Types string subTypes		A filter against the agreement asset sub types. Only agreement assets with type LIBRARY_TEMPLATE currently have this field populated.
Visibility string visibility		A filter indicating the visibility level of agreements that get returned in the response.

Example Payload for Search Resources

{
  "data": {
    "scope": [
      "AGREEMENT_ASSETS"
    ],
    "agreementAssetsCriteria": {
      "createdDate": {
        "range": {
          "gt": "2024-01-01T00:00:00Z",
          "lt": "2024-01-01T23:00:00Z"
        }
      }
    }
  }
}

Update Agreement

Updates the agreement in draft state, or update the expiration time on an existing agreement that is already out for signature. | key: updateAgreement

Input	Default	Notes
Agreement ID string / Required agreementId		The agreement identifier, as returned by the agreement creation API or retrieved from the API to fetch agreements. If provided
Agreement State string agreementState		State of the agreement.
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Expiration Date string expirationDate		A range filter against the agreement expiration date.Format would be date-time with an offset from UTC/Greenwich in theISO-8601 format, such as 2007-12-03T10:15:30+01:00.Range terms can be defined as less-than/greater-than or min/max.
Participant Set Info Role string / Required participantsSetInfoRole		Role assumed by all participants in this set (signer, approver, etc.)
Signature Type string signatureType		The type of signature you would like to request - written or e-signature.
Transient Document ID string transientDocumentId		ID for a transient document that will be added to the agreement.

Example Payload for Update Agreement

{
  "fileInfos": [
    {
      "transientDocumentId": "3AAABLblqZhBf0aJb0XZqz5vXy8g3V9R3qQx6..."
    }
  ],
  "name": "Test Agreement",
  "signatureType": "ESIGN",
  "state": "IN_PROCESS",
  "participantSetsInfo": [
    {
      "order": 1,
      "role": "SIGNER",
      "memberInfos": [
        {
          "email": "prismatic@test.com"
        }
      ]
    }
  ]
}

Update Group

Update an existing group. | key: updateGroup

Input	Default	Notes	Example
Connection connection / Required connection
Created string created		Date of creation of the group. Format would be yyyy-MM-dd'T'HH:mm:ssZ	2016-02-25T18:46:19Z
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Group ID string / Required groupId		The unique identifier of the group.
Group Name string groupName		The name of the group.	My Group
Is Default Group string isDefaultGroup		true if the group is default group.

Example Payload for Update Group

{
  "data": {
    "id": "CBJCHBCAABAAIYEoZ3VPDavcqvJm3ni7ATNn-O9N3OPf"
  }
}

Update User

Update a user in the Acrobat Sign system. | key: updateUser

Input	Default	Notes
Company string company		The company of the user.
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Email string / Required email		The email address of the user to be created.
First Name string firstName		The first name of the user.
Initials string initials		The initials of the user.
Last Name string lastName		The last name of the user.
Locale string locale		The locale of the user.
Phone string phone		The phone number of the user.
Title string title		The job title of the user.
User ID string userId		The user identifier, as returned by the user creation API or retrieved from the API to fetch users. If provided
Status string userStatus		Status of the user.

Example Payload for Update User

{
  "email": "replacedEmail@prismatic.io",
  "company": "Not Prismatic"
}

Update Webhook

Updates a webhook | key: updateWebhook

Input	Default	Notes
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Scope string / Required scope		Scope of the webhook
Webhook Agreement Conditional Parameters string Value List webhookAgreementEvents		Conditions which webhook creator can specify for the payload while creating or updating a webhook.
Application Display Name string webhookApplicationDisplayName		The name of the application through which the webhook is created
Application Name string webhookApplicationName		The name of the application through which the webhook is created
Webhook ID string / Required webhookId		The webhook identifier, as returned by the Adobe Sign Webhook API.
Webhook Library Documents Conditional Parameters string Value List webhookLibraryDocumentEvents		Conditions which webhook creator can specify for the payload while creating or updating a webhook.
Webhook MegaSign Conditional Parameters string Value List webhookMegaSignEvents		Conditions which webhook creator can specify for the payload while creating or updating a webhook.
Webhook Name string / Required webhookName		The name of the webhook.
Problem Notification Emails string Value List webhookProblemNotificationEmails		The list of email addresses to which the webhook problem is to be notified.
Webhook Subscription Events string / Required Value List webhookSubscriptionEvents		The list of events for which the webhook subscription is being made.
Webhook URL string / Required webhookUrlInfo		The URL to which the webhook payload is to be delivered.
Webhook Widget Conditional Parameters string Value List webhookWidgetEvents		Conditions which webhook creator can specify for the payload while creating or updating a webhook.

Example Payload for Update Webhook

{
  "name": "Test Webhook",
  "scope": "ACCOUNT",
  "state": "ACTIVE",
  "webhookUrlInfo": {
    "url": "<Your Integration trigger url here>"
  },
  "webhookSubscriptionEvents": [
    "AGREEMENT_ALL"
  ]
}

Adobe Acrobat Sign is an e-signature management solution. Use the Adobe Acrobat Sign component to send, sign, track, and manage the signature process.

Description​

API Documentation​

Connections​

OAuth 2.0​

Triggers​

Webhook​

Data Sources​

Select Agreements​

Select Group​

Select Users​

Actions​

Create Account​

Create Agreement​

Create Group​

Create Transient Document​

Create User​

Create Webhook​

Delete Agreement Documents​

Delete Group​

Delete Webhook​

Download Agreement PDF​

Get Account​

Get Agreement​

Get Group​

Get User​

Get Webhook​

List Agreements​

List Group Events​

List Group Users​

List Groups​

List Users​

List Webhooks​

Raw Request​

Search Resources​

Update Agreement​

Update Group​

Update User​

Update Webhook​