Get business email setup link

Changed on

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

Creates a one-time link to the page where you finish setting up business email on domain. Use it when Get business email status reports the domain as PENDING_SETUP. The page opens with the number of mailboxes you bought already filled in.

domain isn't checked against your subscriptions, so a domain without business email still returns a link. Check the status first.

Only the workspace owner can create the link. A read-only token is refused, and workspace API keys aren't accepted.

<Note>The link signs whoever opens it in to your workspace's billing account, and it works once. Don't share it, and create a new link each time.</Note>

Each call returns a new link and changes nothing, so retrying is safe. Limited to 6 requests a minute per caller. Some workspaces have a different limit.

post/api/billing/business-email/setup-url

Request

  • Base URL
    https://app.base44.com
  • URL
    https://app.base44.com/api/billing/business-email/setup-url
  • Auth
    HTTP bearer

Request body

domainstring required

Custom domain the business email is for, without www..

Example request

{
  "domain": "acme.com"
}

Response

A one-time link to the business email setup page.

urlstring required

Link to open in the browser of the person who acts on it. Treat it as opaque. It works once, so create a new one each time.

Example response

{
  "url": "https://billing.example.com/session/7c1e9f2a4b8d4e6f9a3c5b7d1e2f4a6c"
}

Changes