> ## Documentation Index
> Fetch the complete documentation index at: https://docs.squarecloud.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Convidar membro para o workspace

> Adicione um membro a um workspace com POST /v2/workspaces/members usando o código de convite dele e uma função: view, manager, maintain ou admin. Só o dono.

<ParamField header="Authorization" type="string" placeholder="Chave da API" required>
  A chave da API para sua conta. Você pode encontrá-la nas [configurações da conta](https://squarecloud.app/pt-br/account/security).
</ParamField>

Requer uma chave de API com o [escopo](/pt-br/api-reference/authentication#escopos) `workspaces:manage`.

Adiciona um membro a um workspace usando um código de curta duração obtido em [Obter código de convite](/pt-br/api-reference/endpoint/workspace/members/code): o usuário convidado é identificado pelo código, e quem faz a chamada define a função dele com `group`. Somente o dono do workspace pode chamar este endpoint, e o número de membros é limitado pelo plano do dono.

A função em `group` define o que o membro pode fazer nas aplicações compartilhadas do workspace: veja [Funções](#funções). Altere uma função depois com [Alterar permissões](/pt-br/api-reference/endpoint/workspace/members/perms). Um dono não pode convidar a si mesmo. Limitado a 1 adição a cada 5 segundos por usuário.

## Funções

O dashboard mostra cada função pelo nome, e a API recebe o valor da coluna `group`.

| Dashboard | `group` | O que o membro pode fazer nas aplicações compartilhadas do workspace |
| - | - | - |
| View | `view` | Somente leitura: informações, status, logs, métricas, análise de rede e histórico de deploys. |
| Manager | `manager` | Tudo o que `view` pode, mais iniciar, parar e reiniciar, e as configurações do deploy atual. |
| Maintain | `maintain` | Tudo o que `view` pode, mais iniciar, parar e reiniciar, commits, arquivos, registros DNS e limpeza de cache. |
| Admin | `admin` | Tudo, incluindo variáveis de ambiente, snapshots, domínios personalizados, o webhook do GitHub e arquivos restritos como `.env`. |

O dono do workspace aparece nas listas de membros com `group: "owner"` e sempre tem acesso total. `owner` não pode ser atribuído.

## Parâmetros

<ParamField body="workspaceId" type="string" placeholder="ID do Workspace" required>
  O ID do workspace.
</ParamField>

<ParamField body="code" type="string" placeholder="Código de convite" required>
  Uma string com o código de convite do membro.
</ParamField>

<ParamField body="group" type="string" placeholder="Nome da permissão" required>
  A função do membro: `view`, `manager`, `maintain` ou `admin`. Veja [Funções](#funções).
</ParamField>

## Resposta

<ResponseField name="status" type="string">
  Indica se a chamada foi bem-sucedida: `success` se foi, `error` se não.
</ResponseField>

<ResponseExample>
  ```json theme={"system"}
  {
    "status": "success"
  }
  ```
</ResponseExample>

## Erros comuns

| Código | HTTP | Significado |
| - | - | - |
| `INVALID_ID` | 400 | `workspaceId` está ausente. |
| `INVALID_CODE` | 400 | O código de convite está ausente, é inválido ou expirou. |
| `CANNOT_INVITE_OWNER` | 400 | O código de convite pertence a quem fez a chamada, que já é dono do workspace. |
| `INVALID_GROUP` | 400 | `group` não é `view`, `manager`, `maintain` ou `admin`. |
| `MEMBERS_LIMIT_REACHED` | 400 | O workspace já atingiu o número máximo de membros do plano. |
| `MEMBER_ALREADY_ADDED` | 400 | O usuário convidado já é membro deste workspace. |
| `WORKSPACE_NOT_FOUND` | 404 | O workspace não existe. |

## Relacionados

* CLI: [`squarecloud workspace member add`](/pt-br/cli-reference/workspace-members#squarecloud-workspace-member-add)
* SDKs: [`api.workspaces.members.add()`](/pt-br/sdks/js/workspaces) (JavaScript), [`client.workspaces.members.add()`](/pt-br/sdks/py/workspaces) (Python), [`c.Workspaces.Members.Add()`](/pt-br/sdks/go/workspaces) (Go)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.