Skip to content

Invite Agency Client User

POST
/agency/clients/{org_id}/invites

Invite a person into a client org (sends an invite email).

409 when the person already has a graph8 account: they are never added without accepting, so an admin adds them in the app. 403 for a client that is not this agency’s; a suspended client you own can still be invited into.

Authorizations

Parameters

Path Parameters

org_id
required

Client org id (org_xxx) from GET /agency/clients.

string

Client org id (org_xxx) from GET /agency/clients.

Header Parameters

X-Target-Org-Id
Any of:
string
Idempotency-Key
Any of:
string

Retry-safety key: replaying one returns the original response instead of creating a second org.

Request Body required

object
email
required

Who to invite.

string
role

Role in the client org.

string
default: Member
Allowed values: Owner Admin Member

Responses

201

Successful Response

object
data
required
object
email
required
string
org_id
required
string
role
required
string
Allowed values: Owner Admin Member
status
required

invited: an invite email was sent. added: the person gained an account an instant earlier and was added directly.

string
Allowed values: invited added
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string