Skip to main content
reachboost invitations has 4 commands. Each one lists its arguments, its flags and what it is allowed to change. Every command also accepts the global flags.

invitations get

Get an invitation. Read-only.
Usage
Arguments
uuid
required
The unique identifier for the invitation. This is not the invitation token.

invitations list

List invitations. Read-only. Pending and expired invitations, newest first. Accepted invitations (the person has joined) and withdrawn invitations are never listed. status is computed: an invitation past its expires_at is expired even though nothing rewrote its stored status, and the filter follows the same rule. Filters combine with AND across fields; role and status take several comma-separated values and match any of them.
Usage
Flags
number
The page number.
number
The number of results per page.
string
Partial match filter on the first name (case-insensitive).
string
Partial match filter on the last name (case-insensitive).
string
Partial match filter on the email address (case-insensitive).
string
Exact match on the role, one or more of workspace_member, workspace_admin, agency_member, agency_admin separated by commas.
string
Exact match on the computed status, one or more of pending, expired, accepted separated by commas. accepted never matches because accepted invitations are not listed.
boolean
Fetch every page (up to 200 pages of 100) instead of one. Cannot be combined with —page.

invitations create

Invite someone to the workspace. Changes data. Creates the invitation and sends the invitation mail the same way the settings page does. role defaults to the member role of the workspace type (workspace_member, or agency_member on an agency workspace) and must be one of that type’s two roles. Because an API key has no user behind it, invited_by is the workspace’s first admin. The response carries invitation_url, which can be handed to the person directly; it is returned whether or not a mail went out (white-label workspaces send none).
Usage
Flags
string
string
string
enum
default:"the member role of the workspace type"
Defaults to the member role of the workspace type. Must be one of that type’s two roles. One of: workspace_member, workspace_admin, agency_member, agency_admin.
JSON
The whole request body as JSON, instead of individual flags.
path
Read the whole request body as JSON from a file, or from stdin with -.
boolean
Show exactly what would be sent, and send nothing.

invitations delete

Withdraw an invitation. Destructive: needs —yes. The invitation stops being listed and its link stops working. Accepted invitations cannot be withdrawn and answer 404.
Needs --yes. Without it the command shows what it would do and stops. Try it with --dry-run first. See Safety.
Usage
Arguments
uuid
required
The unique identifier for the invitation. This is not the invitation token.
Flags
boolean
Show exactly what would be sent, and send nothing.
boolean
Confirm. Without it the command shows what it would do and stops.