Pular para o conteúdo
Healthing CRM

Create Invitation

POST
/api/v1/invitations

Create a new team member invitation (Protected).

Requires: Owner or Admin role

Args: invitation_data: Email and role for the invitation current_user: Current authenticated user db: Database session

Returns: Created invitation details

Authorizations

Seção intitulada “Authorizations ”

Request Body required

Seção intitulada “Request Body required ”
InvitationCreate

Schema for creating a new invitation.

object
email
required
Email

Email address of the person to invite

string format: email
role
required

Role to assign to the invited user

string
Allowed values: owner admin agent viewer
tenant_id
Any of:
integer
Example
{
  "email": "novocolaborador@empresa.com",
  "role": "agent",
  "tenant_id": 1
}

Responses

Seção intitulada “ Responses ”

201

Seção intitulada “201 ”

Successful Response

InvitationResponse

Schema for invitation data in responses.

object
id
required
Id
integer
tenant_id
required
Tenant Id
integer
email
required
Email
string
role
required
UserRole

User roles within a tenant.

string
Allowed values: owner admin agent viewer
status
required
InvitationStatus

Invitation status

string
Allowed values: pending accepted expired cancelled
token
required
Token
string
invited_by_user_id
required
Invited By User Id
integer
expires_at
required
Expires At
string format: date-time
accepted_at
Any of:
string format: date-time
cancelled_at
Any of:
string format: date-time
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
tenant_name
Any of:
string
invited_by_name
Any of:
string
Example
{
  "created_at": "2025-11-01T12:00:00Z",
  "email": "novocolaborador@empresa.com",
  "expires_at": "2025-11-08T12:00:00Z",
  "id": 1,
  "invited_by_user_id": 3,
  "role": "agent",
  "status": "pending",
  "tenant_id": 1,
  "token": "abc123def456",
  "updated_at": "2025-11-01T12:00:00Z"
}

422

Seção intitulada “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string