bots.createBotInvitation

POST

/v1/bots/{botId}/invitations

const url = 'https://example.com/v1/bots/example/invitations';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"email":"example","expiresAt":1,"path":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

token
session

Parameters

Path Parameters

botId

required

string

>= 1 characters <= 128 characters

Request Body^required

application/json

object

email

string

<= 320 characters

expiresAt

number

path

string

<= 4096 characters

Example ^generated

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

Responses

201

Success

application/json

object

invitation

required

object

required

string

>= 1 characters <= 128 characters

bot

required

string

>= 1 characters <= 128 characters

email

required

Any of:

string
null

string

prefix

required

Any of:

string
null

string

path

required

Any of:

string
null

string

<= 4096 characters

status

required

string

Allowed values: pending accepted declined revoked expired

invitedBy

required

string

createdAt

required

string

expiresAt

required

Any of:

string
null

string

secret

required

Any of:

string
null

string

url

required

Any of:

string
null

string

Example

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

400

BotInvalid | InvitationInvalid | OrganizationRequired

application/json

Any of:

object

_tag

required

string

Allowed values: BotInvalid

message

required

string

Example

{
  "_tag": "BotInvalid"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

application/json

Any of:

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

Example

{
  "_tag": "Forbidden"
}

404

BotNotFound | InvitationNotFound

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: BotNotFound

bot

required

string

Example

{
  "_tag": "BotNotFound"
}

409

@nmnmcc/ability/Authorizer/Pending | BotConflict

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

Example

{
  "_tag": "Pending"
}

429

RateLimited

application/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

BotStorageUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: PolicyUnavailable

Example

{
  "_tag": "PolicyUnavailable"
}

bots.createBotInvitation

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Example generated

Responses

201

Example

400

Example

401

Example

403

Example

404

Example

409

Example

429

Example

503

Example

Request Body^required

Example ^generated