Skip to content
OpenBot

bots.createBotInvitation

POST
/v1/bots/{botId}/invitations
curl --request POST \
  --url https://example.com/v1/bots/example/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "email": "example", "expiresAt": 1, "path": "example" }'

Invites a person by email, or makes an invitation link, to use this Bot. It needs bots.share. Only a lasting top Bot can be shared.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
botId
required
string
>= 1 characters <= 128 characters

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
email
string
<= 320 characters
expiresAt
number
path
string
<= 4096 characters

Example generated

{
  "email": "example",
  "expiresAt": 1,
  "path": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

Success

Media typeapplication/json
object
invitation
required
object
id
required
string
>= 1 characters <= 128 characters
bot
required
string
>= 1 characters <= 128 characters
email
required
Any of:
string
prefix
required
Any of:
string
path
required
Any of:
string
<= 4096 characters
status
required
string
Allowed values: pending accepted declined revoked expired
invitedBy
required
string
createdAt
required
string
expiresAt
required
Any of:
string
secret
required
Any of:
string
url
required
Any of:
string

Example 

{
  "invitation": {
    "status": "pending"
  }
}

400

Section titled “400”

BotInvalid | InvitationInvalid | OrganizationRequired

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: BotInvalid
message
required
string

Example 

{
  "_tag": "BotInvalid"
}

401

Section titled “401”

AuthenticationRequired

Media typeapplication/json
object
_tag
required
string
Allowed values: AuthenticationRequired

Example 

{
  "_tag": "AuthenticationRequired"
}

403

Section titled “403”

PermissionDenied | MembershipRequired | ForbiddenOrigin

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: PermissionDenied
permission
required
string
Allowed values: responses.run sessions.read sessions.write requests.resolve bots.read bots.write bots.delegate bots.share triggers.read triggers.write channels.read channels.write channels.use channel_identities.read channel_identities.write connections.read connections.write apps.use apps.publish computers.read computers.write computers.use computer_providers.read computer_providers.write computer_providers.use models.use tokens.read tokens.write organization.read organization.write roles.write model_providers.read model_providers.write sso.read sso.write platform.read platform.write members.read members.write audit_logs.read usage.read budgets.read budgets.write
resource
required
string

Example 

{
  "_tag": "PermissionDenied",
  "permission": "responses.run"
}

404

Section titled “404”

BotNotFound | InvitationNotFound

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: BotNotFound
bot
required
string

Example 

{
  "_tag": "BotNotFound"
}

409

Section titled “409”

BotConflict

Media typeapplication/json
object
_tag
required
string
Allowed values: BotConflict
message
required
string

Example 

{
  "_tag": "BotConflict"
}

429

Section titled “429”

RateLimited

Media typeapplication/json
object
_tag
required
string
Allowed values: RateLimited
retryAfterSeconds
required
integer
>= -9007199254740991 <= 9007199254740991

Example 

{
  "_tag": "RateLimited"
}

503

Section titled “503”

AuthorizationUnavailable | BotStorageUnavailable | AuthenticationUnavailable

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: AuthorizationUnavailable

Example 

{
  "_tag": "AuthorizationUnavailable"
}