post_ownership_transfers_by_orgid_by_transferid_cancel

Changes data · you confirm first

Calls POST /api/ownership-transfers/{orgId}/{transferId}/cancel as the signed-in person · REST reference

Cancel a pending ownership transfer

The owner who started it, or platform staff (403 for anyone else — the member it names declines by not confirming). Both codes stop working.

Arguments

ArgumentTypeDescription
orgIdpathstring (uuid)required
transferIdpathstring (uuid)required
bodyJSONobjectThe request body, as a JSON object. Its fields are listed below.

Fields of body

FieldTypeDescription
reasonstring

Example call

A client sends this over the MCP session; Claude and other agents build it for you. The values are placeholders — the shape is real.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "post_ownership_transfers_by_orgid_by_transferid_cancel",
    "arguments": {
      "orgId": "11111111-1111-4111-8111-111111111111",
      "transferId": "11111111-1111-4111-8111-111111111111",
      "body": {
        "reason": "string"
      }
    }
  }
}
Confirmation
The client shows the person the exact request and waits. Nothing runs until they tick Make this change. See Reading and changing.

Result

On success (HTTP 200) the tool returns one text item holding the API's JSON, pretty-printed.

Cancelled.

json
{
  "data": {
    "createdAt": 1,
    "expiresAt": 1,
    "from": {
      "email": "string",
      "side": "FROM",
      "userId": "11111111-1111-4111-8111-111111111111",
      "verified": true,
      "firstName": "string",
      "lastName": "string",
      "verifiedAt": 1
    },
    "id": "11111111-1111-4111-8111-111111111111",
    "orgId": "11111111-1111-4111-8111-111111111111",
    "orgName": "string",
    "status": "PENDING",
    "to": {
      "email": "string",
      "side": "FROM",
      "userId": "11111111-1111-4111-8111-111111111111",
      "verified": true,
      "firstName": "string",
      "lastName": "string",
      "verifiedAt": 1
    },
    "cancelReason": "string",
    "cancelledAt": 1,
    "completedAt": 1
  },
  "success": true
}

Fields

FieldTypeDescription
dataobject
data.cancelReasonstring | null
data.cancelledAtinteger | null
data.completedAtinteger | null
data.createdAtintegerEpoch milliseconds.
data.expiresAtintegerEpoch milliseconds — the deadline both sides must confirm by. The same lifetime as every other code (OTP_EXPIRY_SECONDS).
data.fromobject
data.from.emailstring
data.from.firstNamestring | null
data.from.lastNamestring | null
data.from.side"FROM" | "TO"FROM is the current owner who started the transfer; TO is the member who becomes the owner.
data.from.userIdstring (uuid)
data.from.verifiedbooleanWhether this side has confirmed with their code.
data.from.verifiedAtinteger | nullEpoch milliseconds.
data.idstring (uuid)
data.orgIdstring (uuid)
data.orgNamestring
data.status"PENDING" | "COMPLETED" | "CANCELLED" | "EXPIRED"
data.toobject
data.to.emailstring
data.to.firstNamestring | null
data.to.lastNamestring | null
data.to.side"FROM" | "TO"FROM is the current owner who started the transfer; TO is the member who becomes the owner.
data.to.userIdstring (uuid)
data.to.verifiedbooleanWhether this side has confirmed with their code.
data.to.verifiedAtinteger | nullEpoch milliseconds.
successtrue

When it fails

A failed call returns isError: true with the API's message as text. A change the person declines, or lets time out, also comes back this way and nothing changes.

400

The request was malformed or failed a guard.

403

Authenticated, but the caller holds none of the required permissions.

404

No transfer with that id for this organization.

409

The resource is not in a state that allows this operation.

What the model is shown

This is the tool exactly as the server lists it in tools/list. The description starts with the REST call it makes.

json
{
  "name": "post_ownership_transfers_by_orgid_by_transferid_cancel",
  "description": "POST /api/ownership-transfers/{orgId}/{transferId}/cancel — The owner who started it, or platform staff (403 for anyone else — the member it names declines by not confirming). Both codes stop working.\n\nThis changes data. The person is asked to confirm it before it runs, and nothing happens if they decline.",
  "inputSchema": {
    "type": "object",
    "properties": {
      "orgId": {
        "type": "string"
      },
      "transferId": {
        "type": "string"
      },
      "body": {
        "type": "string",
        "description": "The JSON request body: { reason: string }"
      }
    },
    "required": [
      "orgId",
      "transferId"
    ]
  },
  "annotations": {
    "readOnlyHint": false,
    "destructiveHint": true,
    "idempotentHint": false,
    "openWorldHint": false
  }
}