Organizations

Offboard an affiliate

Reclaim an affiliate's remaining credits to the parent and then suspend it. Requires the orgs:manage scope. Reclaim, suspension and their audit records commit together in one transaction. A failed transaction rolls back the reclaim; a transport failure does not establish whether it committed. Retrying is safe and never moves the same credits twice. The affiliate's anchored records are NOT touched — they stay verifiable after the relationship ends. Lifecycle: a child requests affiliation (dashboard) and becomes PENDING; approve moves PENDING to APPROVED; credits move only while the affiliate is APPROVED and not suspended; offboard reclaims the remaining credits and suspends the affiliate, in any status; revoke ends the relationship from APPROVED or PENDING. offboard then revoke and revoke then offboard are both supported - offboard never requires APPROVED and revoke never refuses a suspended affiliate. Counts against the API key monthly usage quota (no exemption exists for administration routes) and requires the organization payment state to be current.

post/organizations/sub-orgs/offboard

Request

  • Base URL: https://app.arkova.ai/api/v1
  • URL: https://app.arkova.ai/api/v1/organizations/sub-orgs/offboard
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

org_public_idstring required

Public identifier of the affiliated organization. NOT the internal uuid — sending one returns 400 use_public_id.

reasonstring

Example request

{
  "org_public_id": "k7mqx3ptr9wz"
}

Response

Offboarded

reclaimedinteger required

Credits returned to the parent by this call. Zero on a retry that already reclaimed.

suspendedboolean required
already_suspendedboolean

True when the affiliate was already suspended before this call.

Changes

No recorded changes to this operation across all 1 revision of this API.