Sign in

Check ownership transfer

Changed on

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Checks whether an ownership transfer invitation can be sent to an email address, and lists what would transfer with the app. Nothing is sent or changed.

Read can_send for the answer. A problem such as an app that already has a pending transfer comes back in blockers rather than as an error, and the same problem stops Start ownership transfer. A recipient without a Base44 account yet is only a warning, since they can sign up before they accept.

Use transfer_package to choose the integration_decisions and secret_decisions you send with the invitation.

You need to own the app or be an owner or admin of its workspace. A workspace admin who doesn't own the app also needs an Enterprise workspace or approved partner status. An invitation to someone outside the workspace needs that status too, and only workspace owners and admins can send one. The workspace's transfer policy can narrow that to owners, or turn it off. If you can't manage ownership transfers for this app, the result has a NOT_APP_OWNER blocker. For an invitation outside the workspace, a missing Enterprise or partner status is rejected instead.

This is limited to 60 requests a minute per workspace. Some workspaces have a different limit.

<Note>This endpoint accepts a personal API key. A read-only key is refused, and workspace API keys are not accepted.</Note>

post/api/apps/{app_id}/ownership/transfer/preflight

Request

  • Base URL: https://app.base44.com
  • URL: https://app.base44.com/api/apps/{app_id}/ownership/transfer/preflight
  • Auth: HTTP bearer

Path parameters

app_idstring required

ID of the app.

Request body

new_owner_emailstring required

Email address of the new owner. An invalid address comes back as a blocker.

destination'same_workspace' | 'external_email' nullable

Either same_workspace, to invite an owner, admin, editor, or member of the app's workspace, or external_email, to invite anyone. Defaults to external_email.

Example request

{
  "new_owner_email": "jane@acme.com",
  "destination": "external_email"
}

Response

The result of the check.

can_sendboolean required

Whether the invitation can be sent (true) or a blocker stops it (false).

recipient_statusstring required

Summary of the result. Either can_send, recipient_must_sign_in_first when the recipient doesn't have a Base44 account yet but the invitation can still be sent, invalid_email, or blocked_policy for any other blocker.

Example response

{
  "can_send": true,
  "recipient_status": "can_send",
  "blockers": [
    {
      "code": "TRANSFER_ALREADY_PENDING",
      "severity": "blocker",
      "message": "A pending ownership transfer already exists for Acme CRM.",
      "field": "new_owner_email",
      "details": {}
    }
  ],
  "warnings": [
    {
      "code": "TRANSFER_ALREADY_PENDING",
      "severity": "blocker",
      "message": "A pending ownership transfer already exists for Acme CRM.",
      "field": "new_owner_email",
      "details": {}
    }
  ],
  "transfer_package": {
    "mode": "transfer_as_built",
    "app": {
      "id": "6820f3a4e7b91d003c45a1f2",
      "name": "Acme CRM",
      "source_workspace_id": "67f2c8e01a3b5d004e92d7a1",
      "source_owner_id": "6820f3a4e7b91d003c45a1f0"
    },
    "recipient_email": "jane@acme.com",
    "existing_account_required": true,
    "target_workspace": "recipient_personal_workspace",
    "active_integration_count": 1,
    "integrations": [
      {
        "integration_type": "slack",
        "display_name": "Slack",
        "status": "active",
        "can_keep_connected": true
      }
    ],
    "secrets": [
      {
        "secret_name": "STRIPE_API_KEY",
        "has_value": true
      }
    ]
  }
}

Changes