Criar marcador no Gmail, por uma API

Cria um marcador e o retorna com seu id, para aplicar com Update message labels. O nome não pode ser o de um marcador do sistema nem o de um marcador existente.

Identificador
gmail_create_label

A chamada

POST https://connect.reportei.com/api/tools/gmail_create_label/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "name": "<name>"
  }
}

Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
namestringSimName of the label, as Gmail shows it.
labelListVisibilitystringNãoWhether the label shows in the label list of Gmail: always, only while it has unread messages, or never.Valores: labelShow, labelShowIfUnread, labelHide
messageListVisibilitystringNãoWhether the label shows on the messages in the message list of Gmail.Valores: show, hide

Conexões possíveis

O seu cliente conecta a conta do Gmail uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

OAuth com o app do seu produto

Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/gmail, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.

A resposta

Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/gmail_create_label. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Gmail

Ver as 12 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.