Skip to main content
POST
/
agencies
/
invites
Invite a team member
curl --request POST \
  --url https://api.example.com/agencies/invites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Fanvue-API-Version: <x-fanvue-api-version>' \
  --data '
{
  "email": "jsmith@example.com"
}
'
{
  "success": true,
  "message": "Invitation sent successfully.",
  "inviteUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
Required scope
  • write:agency — Manage agency team members and invites, including inviting new team members and creators.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 access token, presented as a JWT bearer token in the Authorization header. Obtain a token via the authorization-code flow; the scopes granted to the token determine which operations it may call.

Headers

​
X-Fanvue-API-Version
string
default:2025-06-26
required

API version to use for the request

Example:

"2025-06-26"

Body

application/json
​
email
string<email>
required

Email address of the user to invite

Response

Team member invited successfully

​
success
boolean
required
​
message
string
required
​
inviteUuid
string<uuid>
required