Create custom provision definition | Docusign

{
  "key": "string",
  "label": "string",
  "category": "GENERAL",
  "type": "STRING",
  "options": [
    "string"
  ],
  "associations": [
    "string"
  ],
  "metadata": {
    "created_at": "2024-01-15T09:30:00Z",
    "created_by": "string",
    "modified_at": "2024-01-15T09:30:00Z",
    "modified_by": "string",
    "request_id": "3f7c9e4b-851c-4f9b-89e7-123456789abc",
    "response_timestamp": "2024-10-17T14:30:00Z",
    "response_duration_ms": 150
  },
  "response_metadata": {
    "request_id": "3f7c9e4b-851c-4f9b-89e7-123456789abc",
    "response_timestamp": "2024-10-17T14:30:00Z",
    "response_duration_ms": 150,
    "page_limit": 10
  },
  "_links": {
    "first": {
      "href": "https://api.docusign.com/v1/accounts/12345678/agreements?limit=10&ctoken=abc123"
    },
    "self": {
      "href": "https://api.docusign.com/v1/accounts/12345678/agreements?limit=10&ctoken=abc123"
    },
    "next": {
      "href": "https://api.docusign.com/v1/accounts/12345678/agreements?limit=10&ctoken=abc123"
    }
  }
}

Creates a new custom provision definition for the specified account.

Authentication

AuthorizationBearer

OAuth2 authentication.

Demo:
- authorizationUrl: https://account-d.docusign.com/oauth/auth
- tokenUrl: https://account-d.docusign.com/oauth/token
Production:
- authorizationUrl: https://account.docusign.com/oauth/auth
- tokenUrl: https://account.docusign.com/oauth/token

Path parameters

accountIdstringRequiredformat: "^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$"

Request

A provision definition.

keystring or nullOptional

Stable machine identifier for the provision. Populated on GET and POST responses; ignored on POST request bodies.

labelstringOptional

Human-readable display name for the provision. May contain spaces, punctuation, and mixed case.

categoryenumOptional

The category a provision field belongs to.

typeenumOptional

The data type of the provision

Allowed values:

optionslist of stringsOptional

Available options when type is LIST.

associationslist of stringsOptional

Associated resources or contexts for this provision.

metadataobjectOptional

Response

The provision definition was created successfully.

keystring or nullOptional

Stable machine identifier for the provision. Populated on GET and POST responses; ignored on POST request bodies.

labelstringOptional

Human-readable display name for the provision. May contain spaces, punctuation, and mixed case.

categoryenumOptional

The category a provision field belongs to.

typeenumOptional

The data type of the provision

Allowed values:

optionslist of stringsOptional

Available options when type is LIST.

associationslist of stringsOptional

Associated resources or contexts for this provision.

metadataobjectOptional

response_metadataobjectOptional

Control information and metadata for the response.

_linksobjectOptional

Hypermedia controls (HATEOAS) for navigating between pages in a paginated collection of results. Links for the current page, next page, and previous page, with optional first and last page links.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error