Create a legal term
/legal-termsConfigures the legal term for a scope. There is at most one legal term for the platform and one per product, and legal terms are not versioned.
The product scope requires product_id. If the scope already has a legal term, the request is rejected; use the update operation to change its text.
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
Header Parameters
Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Required by this operation: a missing key returns idempotency_key_required, and a malformed key returns idempotency_key_invalid. Repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.
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 POST "https://example.com/legal-terms" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ -d '{ "body": { "blocks": [ {} ] }, "scope": "platform" }'{ "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" }}List legal terms GET
Lists the configured legal terms: at most one for the platform and one per product. The collection can be filtered by scope and product. The term body is not included in the collection; use the retrieve operation to obtain it. When the credentials are restricted to specific legal terms, only those terms are returned. Returns all matching legal terms in a single response while preserving the standard collection response format.
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.