createInvite

POST

/api/v1/workspaces/{workspaceId}/invites

createInvite

curl --request POST \
  --url '<base-url>/api/v1/workspaces/<workspaceId>/invites' \
  --header 'Content-Type: application/json' \
  --cookie 'agenthold_session=<agenthold_session>' \
  --data '
{
  "role": "admin",
  "email": "string",
  "expiresInHours": 1
}
'

const url = '<base-url>/api/v1/workspaces/<workspaceId>/invites';
const options = {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    cookie: 'agenthold_session=<agenthold_session>'
  },
  body: JSON.stringify({role: 'admin', email: 'string', expiresInHours: 1})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "<base-url>/api/v1/workspaces/<workspaceId>/invites"

payload = {
    "role": "admin",
    "email": "string",
    "expiresInHours": 1
}
headers = {
    "cookie": "agenthold_session=<agenthold_session>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "id": "string",
  "role": "admin",
  "email": "string",
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "expiresAt": "2019-08-24T14:15:22Z",
  "token": "string",
  "url": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

Authorization

session
optional
API key in cookie

token
optional
HTTP Bearer
Authorization: Bearer <token>

Path parameters

workspaceId
string
required

Request body JSON required

role
admin
or
member
required
email
optional
string
If set, only a user with this email can accept.
expiresInHours
optional
integer
Defaults to 168 (7 days).

maximum: 720 · minimum: 1

Returns

201

Created. The token is only returned once.

JSON

id
string
required
role
admin
or
member
required
email
string
required
createdBy
string
required
createdAt
string
required
format: date-time
expiresAt
string
required
format: date-time
token
string
required
url
string
required
Link to share with the invitee.

400

Error.

JSON

error
string
required

403

Error.

JSON

error
string
required

404

Error.

JSON

error
string
required