Skip to content
Vocapable Developers

Invite an admin, manager, or representative to this workspace

POST
/v1/mobile/team/invitations
curl --request POST \
  --url https://api.vocapable.com/v1/mobile/team/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "email": "example", "role": "admin", "human_rep_id": "example", "expires_at": "2026-04-15T12:00:00Z" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
TenantInvitationCreateRequest

An admin-issued invitation. The server hashes its generated secret before write.

object
email
required
Email
string
>= 3 characters <= 254 characters
role
required
TenantMembershipRole

The only roles a customer can hold in one workspace.

string
Allowed values: admin manager rep
human_rep_id
Any of:
string
>= 1 characters <= 128 characters
expires_at
required
Expires At
string format: date-time

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
TenantInvitationSummary
object
id
required
Id
string
email
required
Email
string
role
required
TenantMembershipRole

The only roles a customer can hold in one workspace.

string
Allowed values: admin manager rep
human_rep_id
Any of:
string
status
required
Status
string
Allowed values: pending accepted revoked
expires_at
required
Expires At
string format: date-time
accepted_at
Any of:
string format: date-time
revoked_at
Any of:
string format: date-time
Example
{
  "role": "admin",
  "status": "pending"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}