Skip to main content
POST
/
organizations
/
{organizationId}
/
memberships
Criar Membership
curl --request POST \
  --url https://api.example.com/organizations/{organizationId}/memberships \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userId": "<string>",
  "roleSlug": "<string>"
}
'
{
  "membershipId": "om_01HQZC8G2T9YX5J8VQBW3KPQR7",
  "userId": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
  "role": {
    "slug": "member"
  },
  "status": "ACTIVE",
  "createdAt": "2026-03-25T14:00:00.000Z",
  "updatedAt": "2026-03-25T14:00:00.000Z"
}
Cria uma nova membership.
curl -X POST https://api.awsales.io/studio/organizations/ORG_ID/memberships \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "userId": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
    "roleSlug": "member"
  }'
Requer permissao memberships:write.

Cabecalhos

Authorization
string
required
Token bearer.

Parametros de Rota

organizationId
string
required
O UUID da organizacao.

Corpo da Requisicao

userId
string
required
O ID do usuario a ser adicionado como membro.
roleSlug
string
O slug do role a ser atribuido.

Resposta

membershipId
string
O identificador unico da membership.
userId
string
O ID do usuario.
organizationId
string
O UUID da organizacao.
role
object
O role atribuido.
status
string
O status da membership.
createdAt
string
Timestamp de criacao (ISO 8601).
updatedAt
string
Timestamp da ultima atualizacao (ISO 8601).
{
  "membershipId": "om_01HQZC8G2T9YX5J8VQBW3KPQR7",
  "userId": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
  "role": {
    "slug": "member"
  },
  "status": "ACTIVE",
  "createdAt": "2026-03-25T14:00:00.000Z",
  "updatedAt": "2026-03-25T14:00:00.000Z"
}

Codigos de Erro

StatusCodigoDescricao
400validation_errorEntrada invalida ou campos obrigatorios ausentes
401unauthorizedAutenticacao ausente ou invalida
403forbiddenPermissoes insuficientes
404organization.not_foundOrganizacao nao encontrada
409membership.already_existsMembership ja existe para este usuario
500internal_server_errorOcorreu um erro inesperado