Skip to main content

Agreement

Overview

Publish agreements and track who accepted which version. You can target specific audiences and see acceptance status over time.

Primary Concepts

  • Agreement: a document that requires acceptance.
  • Version: a fixed copy of the agreement text.
  • Acceptance: who accepted, which version, and when.
  • Status: required, pending, or completed.
  • Audience: who needs to accept.

Typical Scenarios

Show agreements to users, record acceptance, and check who has accepted the current version.

API Versioning

  • Only the latest version of each endpoint is displayed in this documentation.
  • Older versions are not shown but remain available in the API.
  • Always use the latest version shown when building or updating integrations.