v1Recursos/Team
Team
Gerencie a equipe da sua agência — liste membros, convide novos, atualize sua capacidade, permissões ou usuário do Slack vinculado, e reenvie ou revogue convites. Observação: emitir uma chave de API com team:write exige que a pessoa que cria a chave já seja owner, admin ou membro da equipe Synup. Essa verificação ocorre uma única vez, em Settings, quando a chave é criada — não em cada solicitação individual — então, se sua tentativa de criar uma chave team:write for recusada, é por isso, mesmo que as chamadas REST documentadas abaixo nunca a verifiquem novamente por conta própria.
Retorna a equipe da sua agência — todo usuário na sua agência, exceto o Synup Bot por agência.
Listar membros da equipe
get
team:read/api/v1/team/membersResposta
dataarray of objectopcional
idstringopcional
Identificador único do membro da equipe.
firstNamestringopcional
O primeiro nome do membro da equipe.
lastNamestringopcional
O sobrenome do membro da equipe.
emailstringopcional
O endereço de e-mail do membro da equipe.
rolestringopcional
O papel do membro da equipe, ex.: "owner" ou "member".
invitationStatusstringopcional
O estado de convite do membro: "invited", "accepted", ou null para um membro que nunca passou pelo fluxo de convite.
lastSessionAtstringopcional
Quando o membro teve por último uma sessão ativa, como timestamp ISO 8601, ou null se nunca.
createdAtstringopcional
Quando o membro da equipe foi criado, como timestamp ISO 8601.
weeklyHoursCapacitynumberopcional
A capacidade de horas semanais de trabalho do membro, ou null se não definida.
permissionsobjectopcional
Flags de acesso por módulo (dashboard, clients, listings, etc.), ou null se nunca definidas.
slackUserIdstringopcional
O ID de usuário do Slack vinculado a este membro, ou null se nenhum.
statusstring (Owner | Invited | Active | Not Active)opcional
Um resumo calculado do estado do membro: "Owner", "Invited", "Active", ou "Not Active" (aceito, mas sem sessão nos últimos 7 dias).
Erros
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
get/api/v1/team/members
Sua chave de API
{}v1Recursos/Team/postConvidar um membro da equipe
Convida um novo membro da equipe por e-mail. O membro convidado é sempre criado com o papel "member" e, a menos que permissions seja informado, a predefinição de permissões padrão de membro — uma chave de API nunca pode convidar alguém como owner ou admin.
Convidar um membro da equipe
post
team:write/api/v1/team/membersCorpo da solicitação
firstNamestringobrigatório
O primeiro nome do novo membro da equipe.
lastNamestringobrigatório
O sobrenome do novo membro da equipe.
emailstringobrigatório
O endereço de e-mail do novo membro da equipe.
permissionsobjectopcional
Flags de acesso por módulo a conceder. Opcional; quando omitido (ou vazio), a predefinição de permissões padrão de membro é usada.
Resposta
dataobjectopcional
userIdstringopcional
ID do membro da equipe recém-convidado.
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
409A solicitação entra em conflito com o estado atual do recurso — por exemplo, alterar o e-mail ou telefone de um destinatário que já recebeu uma mensagem, ou um convite de equipe que já foi aceito (ou que ainda não foi aceito).
422Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
post/api/v1/team/members
Sua chave de API
Corpo da solicitação*
{}v1Recursos/Team/patchAtualizar um membro da equipe
Atualiza a capacidade de horas semanais, as permissões de módulo ou o usuário do Slack vinculado de um membro da equipe. Pelo menos um campo deve ser fornecido. Isto não pode alterar o papel de um membro.
Atualizar um membro da equipe
patch
team:write/api/v1/team/membersCorpo da solicitação
memberIdstringobrigatório
ID do membro da equipe.
weeklyHoursCapacitynumberopcional
Nova capacidade de horas semanais de trabalho, entre 0 e 80.
permissionsobjectopcional
Flags de acesso por módulo a conceder. Opcional; quando omitido (ou vazio), a predefinição de permissões padrão de membro é usada.
slackUserIdstringopcional
ID de usuário do Slack para vincular a este membro, ou null para desvincular. Vincular um ID do Slack já usado por outro membro o desvincula desse outro membro.
Resposta
dataobjectopcional
memberobjectopcional
Os campos realmente alterados por esta atualização — não o perfil completo do membro. Consulte GET /api/v1/team/members para ver o registro completo.
idstringopcional
Identificador único do membro da equipe.
weeklyHoursCapacitynumberopcional
A capacidade de horas semanais de trabalho do membro, ou null se não definida.
permissionsobjectopcional
Flags de acesso por módulo (dashboard, clients, listings, etc.), ou null se nunca definidas.
slackUserIdstringopcional
O ID de usuário do Slack vinculado a este membro, ou null se nenhum.
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
404O recurso não foi encontrado, ou não pertence à sua agência.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
patch/api/v1/team/members
Sua chave de API
Corpo da solicitação*
{}v1Recursos/Team/deleteRemover um membro da equipe
Remove um membro da equipe da agência. O proprietário da agência não pode ser removido.
Remover um membro da equipe
delete
team:write/api/v1/team/membersParâmetros de consulta
memberIdstringobrigatório
ID do membro da equipe a ser removido.
Resposta
dataobjectopcional
removedbooleanopcional
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
404O recurso não foi encontrado, ou não pertence à sua agência.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
delete/api/v1/team/members
Sua chave de API
memberId *
{}v1Recursos/Team/postReenviar um convite de equipe
Gera um novo link de convite e reenvia o e-mail de convite para um membro da equipe que ainda não aceitou.
Reenviar um convite de equipe
post
team:write/api/v1/team/members/resend-inviteCorpo da solicitação
memberIdstringobrigatório
ID do membro da equipe.
Resposta
dataobjectopcional
resentbooleanopcional
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
404O recurso não foi encontrado, ou não pertence à sua agência.
409A solicitação entra em conflito com o estado atual do recurso — por exemplo, alterar o e-mail ou telefone de um destinatário que já recebeu uma mensagem, ou um convite de equipe que já foi aceito (ou que ainda não foi aceito).
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
post/api/v1/team/members/resend-invite
Sua chave de API
Corpo da solicitação*
{}v1Recursos/Team/postRevogar o acesso de um membro da equipe
Remove um membro da equipe que já aceitou seu convite. O proprietário da agência não pode ser revogado, e um membro que ainda não aceitou seu convite deve ser removido com DELETE /api/v1/team/members em vez disso.
Revogar o acesso de um membro da equipe
post
team:write/api/v1/team/members/revokeCorpo da solicitação
memberIdstringobrigatório
ID do membro da equipe.
Resposta
dataobjectopcional
revokedbooleanopcional
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
404O recurso não foi encontrado, ou não pertence à sua agência.
409A solicitação entra em conflito com o estado atual do recurso — por exemplo, alterar o e-mail ou telefone de um destinatário que já recebeu uma mensagem, ou um convite de equipe que já foi aceito (ou que ainda não foi aceito).
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
post/api/v1/team/members/revoke
Sua chave de API
Corpo da solicitação*
{}