DoctavianDoctavian
ClickwrapTerm definitions

Term Definition Create

POST
/termDefinitions/create

This endpoint allows you to create a term definition — a versioned, immutable record containing the text or HTML content that will be shown to end-users during the Clickwrap acceptance process. Term definitions serve as the legal source of truth and historical record of what was presented to users at the time of acceptance. Because of their legal and audit purpose, term definitions cannot be updated or deleted via API. Once created, they can only be retrieved.

Authorization

X-Subscription-Key<token>

In: header

Header Parameters

Authorization*string

JWT token to authenticate the request on behalf of a specific Microsoft user or a backend service principal.

X-Subscription-Key*string

Unique API key used to identify and authorize access to a specific environment

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/termDefinitions/create" \  -H "Authorization: Bearer {{authToken}}" \  -H "X-Subscription-Key: {{apiKey}}" \  -H "Content-Type: application/json" \  -d '{    "externalContext": {      "id": "12345"    },    "termDefinition": {      "name": "{{termTitle}}",      "code": "{{termVersionCode}}",      "text": "{{termText}}"    }  }'
{  "result": {    "statusCode": 201,    "message": "Created",    "data": [      {        "termDefinition": {          "termDefinitionId": "{{guid}}"        }      }    ]  },  "externalContext": {    "id": "{{externalContextId}}"  },  "origin": "{{originEnvironment}}",  "dateTime": "{{responseTimestamp}}",  "userId": "{{userId}}"}