Invite a member
Emails an invitation and returns the pending invite. The invitee becomes a member only once they accept, so they will not appear in the member list yet. Inviting someone as admin additionally requires the calling key to act as an organization owner or admin - a workspace key (ti_ws_) never does, so use a personal key for that.
Path Parameters
"admin" | "editor" | "viewer"Response Body
curl -X POST "https://lynx-api.trulyinbox.com/v2/workspaces/0/members/invite" \ -H "Content-Type: application/json" \ -d '{ "email": "colleague@example.com" }'{
"data": {
"id": 0,
"email": "string",
"role": "owner",
"expiresAt": "2019-08-24T14:15:22Z",
"inviterName": {}
},
"meta": {
"request_id": "req_2f1c…",
"timestamp": "2019-08-24T14:15:22Z"
}
}{
"error": {
"code": "invalid_request",
"message": "string",
"details": {},
"retry_after": 34
},
"meta": {
"request_id": "req_2f1c…",
"timestamp": "2019-08-24T14:15:22Z"
}
}{
"error": {
"code": "invalid_request",
"message": "string",
"details": {},
"retry_after": 34
},
"meta": {
"request_id": "req_2f1c…",
"timestamp": "2019-08-24T14:15:22Z"
}
}List membersGET
List workspace members and their roles Every member of the workspace plus the organization owners, who hold implicit admin on every workspace and so carry no membership row of their own (`isOrgOwner: true`). Pending invites are not members and are not listed.
Update member rolePATCH
Update a member's role `userId` is the `userId` field from the member list. A key cannot change its own principal's role. Organization owners are not editable here. Assigning `admin` - or changing anyone who currently IS an `admin` - additionally requires the caller to act as an organization owner or admin.