Skip to main content
POST
Invite a member

Authorizations

x-api-key
string
header
required

Your ps_ API key

Body

application/json
email
string
required

Normalized to lowercase.

Example:

"alguem@acme.com"

role
enum<string>
required

OWNER is NEVER assignable — becoming the owner is a transfer of ownership.

Available options:
ADMIN,
AGENT,
ANALYST
Example:

"AGENT"

allowedNumberIds
string[]

Limits AGENT/ANALYST to specific numbers. Ignored for ADMIN, which is workspace-wide.

sendEmail
boolean

Defaults to true. With false no e-mail is sent and the response carries inviteUrl — the ONLY time the link appears.

Example:

true

Response

Pending invitation rotated