Track an administrator change using the API

Track and update an ongoing account administrator change request programmatically. The request form itself is Swan-hosted; these operations are public and don't require the requester to be an account member.

Query

Use the publicAccountAdminChange query to retrieve the current state of an account administrator change by its ID.

Open in API Explorer

query publicAccountAdminChange($accountAdminChangeId: ID!) {
  publicAccountAdminChange(accountAdminChangeId: $accountAdminChangeId) {
    ... on AccountAdminChange {
      id
      status
      reason
      admin {
        firstName
        lastName
        email
      }
    }
    ... on NonOngoingAccountAdminChange {
      id
      status
    }
  }
}

The query returns one of two types:

• AccountAdminChange: the full object with all fields, returned when the status is Ongoing.
• NonOngoingAccountAdminChange: a limited object containing only id and status, returned for all other statuses. This protects personal information after the form is submitted.

Mutations

Mutation	Purpose
publicUpdateAccountAdminChange	Updates the account administrator change with new information (reason, admin details, requester details). Only works when the status is Ongoing.
publicFinalizeAccountAdminChange	Submits the completed form for review. Transitions the status from Ongoing to Pending. Requires all fields and documents to be provided.

Rejection types

Rejection	Meaning
AccountAdminChangeNotFoundRejection	The account administrator change ID doesn't exist.
AccountAdminChangeStatusNotEligibleRejection	The current status doesn't allow this operation.
AccountAdminChangeMissingInformationRejection	Required fields are missing from the request.
AccountAdminChangeMissingDocumentsRejection	Required supporting documents haven't been uploaded.

info

The supporting document collection associated with an account administrator change uses the type AccountAdminChange. Upload documents to this collection using the supporting documents flow.