Skip to main content
POST
Reconcile seats against the partner's authoritative active list

Authorizations

Authorization
string
header
required

OAuth 2.0 Authorization Code flow with PKCE. See the integration guide at docs.digitalseaservice.com for the full step-by-step.

Headers

authorization
string | null

Body

application/json

Reconcile DSS seats against the partner's authoritative active-member list.

active_refs is the partner's own list of currently-active member identifiers (each matched against a seat's email AND external_ref). An empty list is rejected (400) so a bad/empty export can never be read as "cancel everyone". By default this is a DRY RUN (apply=false): the diff is returned and nothing is cancelled. A mass-cancel that exceeds max_cancel (or the default safety fraction) is refused unless override_threshold is true.

active_refs
string[]
required

Partner's authoritative list of active member emails / external refs.

apply
boolean
default:false

False = dry run (default). True = actually cancel the diff.

max_cancel
integer | null

Hard ceiling on cancellations; exceeding it trips the threshold guard.

Required range: x >= 0
override_threshold
boolean
default:false

Apply even when the mass-cancel threshold guard trips.

Response

The reconcile diff (dry run, or the result of an applied cancel).

The reconcile diff plus what (if anything) was applied.

active_seats
integer
required
to_cancel
ReconcileToCancelItem · object[]
required
missing_refs
string[]
required
applied
boolean
required
cancelled_count
integer
required
threshold_exceeded
boolean
required