Change type of agreement | Docusign

curl -X PATCH https://api-d.docusign.com/v1/accounts/accountId/agreements/agreementId/actions/change-type \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "type": "MSA_DOCUMENT_DATA"
}'

{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "title": "Non-Disclosure Agreements (NDAs)",
  "type": "NonDisclosureAgreements",
  "category": "Services",
  "status": "active",
  "metadata": {
    "created_at": "2025-03-15T10:30:00.000Z",
    "created_by": "user@example.com",
    "modified_at": "2026-05-08T14:22:00.000Z"
  },
  "_links": {
    "self": {
      "href": "/v1/accounts/{accountId}/agreements/{agreementId}"
    },
    "collection": {
      "href": "/v1/accounts/{accountId}/agreements"
    },
    "agreement_types": {
      "href": "/v1/accounts/{accountId}/agreement-types"
    }
  },
  "_actions": {
    "change_type": {
      "href": "/v1/accounts/{accountId}/agreements/{agreementId}/actions/change-type",
      "method": "PATCH",
      "description": "Change the agreement type to a different configured type."
    }
  }
}

Changes the type of an existing agreement to a different configured type. The target type must exist in the account’s agreement-types collection. Upon successful change, the server recomputes the category based on the new type.

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}[}]?$"

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

Request

JSON payload specifying the target agreement type.

typestringRequired

The name of the target agreement type from the agreement-types collection.

Response

The agreement type has been successfully changed. Returns the updated agreement.

idstringOptionalRead-onlyformat: "uuid"

Unique identifier of the agreement.

titlestringOptional

Title of the agreement.

typestringOptional

The updated agreement type.

categorystringOptional

Server-recomputed category based on new type.

statusstringOptional

Current status of the agreement.

metadataobjectOptional

_linksobjectOptional

Hypermedia links for the agreement.

_actionsobjectOptional

Available actions on the agreement.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error