Skip to main content
POST
Convidar membro

Autorizações

x-api-key
string
header
obrigatório

Sua chave de API ps_

Corpo

application/json
email
string
obrigatório

Normalizado para minúsculas.

Exemplo:

"alguem@acme.com"

role
enum<string>
obrigatório

OWNER NUNCA é atribuível — virar dono é transferência de posse.

Opções disponíveis:
ADMIN,
AGENT,
ANALYST
Exemplo:

"AGENT"

allowedNumberIds
string[]

Restringe AGENT/ANALYST a números específicos. Ignorado para ADMIN, que é workspace-wide.

sendEmail
boolean

Default true. Com false nenhum e-mail sai e a resposta traz inviteUrl — a ÚNICA vez que o link aparece.

Exemplo:

true

Resposta

Convite pendente rotacionado