View as Markdown

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:52 UTC.

`AnnouncementScope`

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

Defines the organizational scope of an announcement, determining who can see it. Follows the platform hierarchy: Host > Tenant > Reseller > Merchant.

Values

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Host`	Host-level (system-wide) announcement visible to all users across all tenants. Only host admins can create. TenantId will be null.
`Tenant`	Tenant-scoped announcement visible to all users within a specific tenant. Tenant admins can create for their own tenant.
`Reseller`	Reseller-scoped announcement visible to users at or below the specified reseller in the hierarchy (including sub-resellers and merchants under them). Uses ResellerPathPrefix with StartsWith matching.
`Merchant`	Merchant-scoped announcement visible to users associated with a specific merchant.

Fields

Field	Type	Description

This model has no documented fields.