authentication
List Invitations
List the organization's invitations still waiting to be answered, expired ones included. Use when showing pending invites, before resending or revoking one. Changes nothing.
List Invitations › Responses
Successful Response
emailexpiredexpires_atflagsidorg_idroleA person's role inside one organization. Per-membership, not per-person.
sent_atInvite Member
Invite a person by email address to join the organization with a role and feature flags, and mail them the link. Use when adding a new member to the organization — there is no direct way to add one.
They join only by accepting it. The flags may not exceed what the caller holds, only an owner invites an owner, and an address already a member is refused. Inviting an address with an invitation still waiting replaces it.
Invite Member › Request Body
emailroleA person's role inside one organization. Per-membership, not per-person.
Invite Member › Responses
Successful Response
emailexpiredexpires_atflagsidorg_idroleA person's role inside one organization. Per-membership, not per-person.
sent_atResend Invitation
Send a waiting invitation again, as yours: a new link for seven more days, and the earlier link stops working. Use when an invited person never received or lost the original link.
path Parameters
invitation_idResend Invitation › Responses
Successful Response
emailexpiredexpires_atflagsidorg_idroleA person's role inside one organization. Per-membership, not per-person.
sent_atList Members
List the people in the caller's organization, with their roles and flags. Use when showing the member list, before changing a role, flags, or removing someone. Changes nothing.
List Members › Responses
Successful Response
What a member reads. everything is an owner or an admin, who read every
conversation and whose access is never set (rule 35); default and
channels are then every conversation, and nothing set on its own.
effective_flagsemailflagsgrantable_flagsidis_activenameorg_idperson_idroleA person's role inside one organization. Per-membership, not per-person.
Remove Member
Remove a person from the organization. Use when someone should lose access entirely, not just a role or a flag. Refused for the last owner.
Every API key that person created here dies with them (api-keys.md); the response names which ones.
path Parameters
membership_idRemove Member › Responses
Successful Response
Get Member Conversation Access
Which conversations a member reads: a level on every channel not set on
its own, and one per channel that is. An owner's or an admin's is
everything and is not set. Owners and admins only.
path Parameters
membership_idGet Member Conversation Access › Responses
Successful Response
One level on a channel (authentication.md rule 32), and the people it
names when it is people -- empty for every other level.
everythingSet Member Conversation Access
Replace which conversations a member reads, per channel key as
GET /interactions/scopes names them: none, all, people (with the
people whose conversations it reaches) or own. Every level but none
also reads what nobody has had and what waits for a person. Owners and
admins only, and not on an owner or an admin, who read everything (400).
A thread its holder can no longer open goes back to waiting. A key that
names no channel, or two that are one channel, answers 422 naming it; a
number is stored in its canonical spelling.
path Parameters
membership_idSet Member Conversation Access › Request Body
One level on a channel (authentication.md rule 32), and the people it
names when it is people -- empty for every other level.
Set Member Conversation Access › Responses
Successful Response
One level on a channel (authentication.md rule 32), and the people it
names when it is people -- empty for every other level.
everythingSet Member Flags
Change which features a member may use. Use when granting or revoking a member's access to a specific feature.
A flag the caller does not hold cannot be granted.
path Parameters
membership_idSet Member Flags › Request Body
flagsSet Member Flags › Responses
Successful Response
What a member reads. everything is an owner or an admin, who read every
conversation and whose access is never set (rule 35); default and
channels are then every conversation, and nothing set on its own.
effective_flagsemailflagsgrantable_flagsidis_activenameorg_idperson_idroleA person's role inside one organization. Per-membership, not per-person.
Set Member Role
Change a member's role. Use when a person's standing in the organization should change. A role decides what they may administer.
path Parameters
membership_idSet Member Role › Request Body
roleA person's role inside one organization. Per-membership, not per-person.
Set Member Role › Responses
Successful Response
What a member reads. everything is an owner or an admin, who read every
conversation and whose access is never set (rule 35); default and
channels are then every conversation, and nothing set on its own.
effective_flagsemailflagsgrantable_flagsidis_activenameorg_idperson_idroleA person's role inside one organization. Per-membership, not per-person.
Get Organization
Read the organization you are acting inside: its name, language, default country, timezone and entitlements. Use when showing org-level settings. Changes nothing.
Get Organization › Responses
Successful Response
default_countryentitled_flagsgrantable_flagsidis_activelanguagenametimezoneUpdate Organization
Change the organization's name, language, default country or timezone. Use when updating organization-level settings — only the fields given.
The language is what the dashboard speaks and what a new agent is created speaking. Existing agents keep the language they already have. The default country is what a bare phone number is read against, and it is set once: after the first record identity is read against it, a change is refused. The timezone is what a scheduled automation's cron expression is read in. Neither re-stamps a value already normalised or a schedule already due.
Update Organization › Request Body
Update Organization › Responses
Successful Response
default_countryentitled_flagsgrantable_flagsidis_activelanguagenametimezoneGet Role Flags
Read the default feature flags each role gets in this organization. Use when showing what a role grants before changing it. Changes nothing.
Get Role Flags › Responses
Successful Response
grantable_flagsSet Role Flags
Set the default feature flags for a role in this organization. Use when changing what every member of a role gets by default, rather than one person's own flags.
Affects what members of that role may reach.
Set Role Flags › Request Body
flagsroleA person's role inside one organization. Per-membership, not per-person.
Set Role Flags › Responses
Successful Response
grantable_flags