Skip to main content

Manage Terms of Use

Terms of Use are legal agreements that consumers must accept before subscribing to API Products.

List terms of use​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/termsOfUse?page=1&size=10" \
  -H "Authorization: Bearer <your-token>"

Create terms of use​

curl -X POST "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/termsOfUse" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "api-terms",
    "displayName": "API Terms of Use"
  }'

Get terms of use​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/termsOfUse/<terms-id>" \
  -H "Authorization: Bearer <your-token>"

Update terms of use​

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/termsOfUse/<terms-id>" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "api-terms",
    "displayName": "API Terms of Use (Revised)"
  }'

Delete terms of use​

curl -X DELETE "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/termsOfUse/<terms-id>" \
  -H "Authorization: Bearer <your-token>"

Terms of use versions​

Terms of use support versioning so you can track changes over time.

List versions​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/termsOfUse/<terms-id>/versions?page=1&size=10" \
  -H "Authorization: Bearer <your-token>"

Create a new version​

curl -X POST "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/termsOfUse/<terms-id>/versions" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "# Terms of Use\n\nBy using this API you agree to..."
  }'

Get a specific version​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/termsOfUse/<terms-id>/versions/<version-id>" \
  -H "Authorization: Bearer <your-token>"

Attach terms to an API Product​

See API Products — Plans & Organizations for attaching terms of use to products.