Businesses

Create a business

Add a business you manage. It starts in test mode and goes live after its own verification. With clientEmail, your client is invited as its admin, and the invitation expires after 7 days. We email the invitation, or with sendInvitationEmail: false we send nothing and you send inviteUrl yourself (white-label).

post/gateway/businesses

Request

  • Base URL: https://api.agentaos.ai/api/v1
  • URL: https://api.agentaos.ai/api/v1/gateway/businesses
  • Auth: API key in header x-api-key

Request body

namestring required

The name buyers see. A brand, not an email.

countrystring required

Where it is registered, ISO 3166-1 alpha-2, upper case.

clientEmailstring email

Invite your client as its admin. Leave it out to run the business yourself. Only an owner of your platform may invite.

sameLegalEntityboolean

true for another app of your own company.

sendInvitationEmailboolean

false: we send no email; you send inviteUrl yourself (white-label).

Response

The business was created.

inviteTokenstring nullable required

The invitation token, or null without clientEmail.

inviteUrlstring nullable required

The link your client opens to accept, or null without clientEmail. Ready to send.

Changes

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