Join Community
DocsDeveloper GuideAPI DocumentationChangelog
Organization

Invite Organization Member

Send an email invitation to add someone to your organization.

Invite a new member to your organization. They'll receive an email with a link to join.

Required: Owner role

POST
/inviteOrganizationMember

Authorization

bearerToken

AuthorizationBearer <token>

API token for YourGPT Public APIs. Create tokens in Settings > API Tokens in your YourGPT dashboard.

In: header

Request Body

application/json

email*string

Email address of the person to invite.

role*string

Role to assign to the new member.

Value in"owner" | "editor" | "viewer" | "billing"

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://api.yourgpt.ai/chatbot/v1/inviteOrganizationMember" \  -H "Content-Type: application/json" \  -d '{    "email": "newmember@example.com",    "role": "editor"  }'
{
  "type": "RXSUCCESS",
  "message": "Invitation Sent Successfully",
  "data": {
    "id": 301,
    "sent_by": 42,
    "email": "invited@example.com",
    "role": "viewer",
    "hash": "abc123def456...",
    "status": "pending",
    "createdAt": "2025-01-15T10:30:00.000Z"
  }
}
{
  "type": "RXERROR",
  "message": "Invalid params"
}
{
  "type": "RXERROR",
  "message": "Invalid or revoked API token"
}
{
  "type": "RXERROR",
  "message": "You do not have permission to perform this action"
}