Update a legal term
/legal-terms/{legal_term_id}Replaces the body of a legal term. Setting body to null removes the legal term; subsequent requests for it return 404.
Changing the text does not invalidate acceptances already recorded, and users are not asked to accept the term again.
Send the ETag returned by the retrieve operation in the If-Match header to avoid overwriting a newer version. Legal terms of replicated accounts and replicated products are read-only.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Header Parameters
Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Optional on this operation; when sent, a malformed key returns idempotency_key_invalid, and repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.
Expected revision of the resource, in the same format as the ETag header (W/"<type>:<id>:<revision>"). If the resource has changed since that revision, the request fails with 412 and the revision_mismatch error code. When omitted, the update is applied to the current revision.
Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.
length <= 64Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/legal-terms/string" \ -H "Content-Type: application/json" \ -d '{ "body": { "blocks": [ {} ] } }'{ "data": { "acceptances_count": 0, "body": { "blocks": [ {} ] }, "id": "string", "object": "legal_term", "product_id": "string", "revision": "string", "scope": "platform", "title": "string", "updated_at": "2019-08-24T14:15:22Z" }}Retrieve a legal term GET
Retrieves a legal term, including its body. The legal term ID is derived from its scope: `trm_platform` for the platform term, or `trm_product_<n>` for a product term, where `<n>` is the numeric part of the product ID (for example, `trm_product_42` for product `prd_42`). The response includes an `ETag` representing the current revision. Send this value in the `If-Match` header when updating the legal term to avoid overwriting a newer version.
List legal term acceptances GET
Lists the acceptances recorded for a legal term. Acceptances are recorded when users accept the term and cannot be created through the API. The collection can be filtered by user and by acceptance date. When the credentials are restricted to specific users, only acceptances by those users are returned. The `proof` object is included only when the credentials have the `legal_terms.read_proof` permission.