Organizations

Revoke an affiliation

Revoke the affiliation of an organization affiliated with the calling key's organization. Requires the orgs:manage scope. Revocation severs the affiliation; it does not reclaim credits or suspend the organization — use /offboard for that. 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/revoke

Request

  • Base URL: https://app.arkova.ai/api/v1
  • URL: https://app.arkova.ai/api/v1/organizations/sub-orgs/revoke
  • 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.

Example request

{
  "org_public_id": "k7mqx3ptr9wz"
}

Response

Affiliation revoked

status'APPROVED' | 'REVOKED' required
public_idstring required

Changes

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