---
title: "Acesso e Permissões à API"
slug: "set-scopes"
updated: 2026-06-12T10:30:57Z
published: 2026-06-12T10:30:57Z
canonical: "docs.xtremepush.com/set-scopes"
---

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

# Acesso e Permissões à API

## Adicionar ID de Cliente

Para criar um ID de cliente, faça o seguinte:

1. Vá em **Configurações** > **Integrações** > **Integrações de API**.
2. Clique **em Criar ID de Cliente** e insira um nome para a integração.
3. Clique em salvar. **Um ID de Cliente** é gerado automaticamente para você.

## Escopos de Cenários

Selecione **Escopos Definidos** para o ID do Cliente correspondente para gerenciar suas permissões. As tabelas descrevem a funcionalidade disponível para cada escopo. Cada operação inclui uma caixa de seleção que permite habilitar ou desativar acessos específicos.

Todas as alterações no escopo são registradas nas colunas **Atualizado Até** e **Tempo Atualizado** .

### Operações Comuns

| Escopo | Permissões | Referência API |
| --- | --- | --- |
| Criar | - Crie uma campanha automatizada ou crie uma campanha a ser enviada imediatamente - Crie um segmento que será associado ao seu projeto - Crie uma lista de usuários que estarão associados ao seu projeto - Crie uma nova tag ou um atributo. | - [Criar Campanha](https://docs.xtremepush.com/reference/campaign-create) - [Criar Segmento](https://docs.xtremepush.com/reference/segment-create) - [Criar Lista](https://docs.xtremepush.com/reference/list-create) - [Criar Tag](https://docs.xtremepush.com/reference/tag-create) |
| Criação em lote | Crie um lote de novas tags ou atributos | [Tags de criação em lote](https://docs.xtremepush.com/reference/tag-batch-create) |
| Atualização | - Atualize uma campanha que já foi criada - Atualize um segmento existente - Atualize uma lista de usuários existente | - [Campanha de Atualização](/tps:/docs.xtremepush.com/reference/campaign-updatehttps:/docs.xtremepush.com/reference/campaign-update) - [Segmento de Atualização](https://docs.xtremepush.com/reference/segment-update) - [Lista de Atualizações](https://docs.xtremepush.com/reference/list-update) |
| Excluir | - Exclua um segmento - Exclua uma lista de usuários | - [Segmento](https://docs.xtremepush.com/reference/segment-delete) - [Lista](https://docs.xtremepush.com/reference/list-delete) |
| Lista | - Campanhas criadas por lista - Liste os dispositivos que usam sua aplicação - Perfis de usuário criados por lista - Liste os segmentos associados ao seu projeto - Liste todas as listas associadas ao seu projeto - Liste todos os itens da lista - Lista de informações sobre ações push relacionadas a campanhas - Liste informações das ações push enviadas para dispositivos ou perfis individuais - Liste status de assinatura a partir dos perfis de usuário - Listar valores de atributos de perfil a partir de perfis de usuário - Liste informações sobre preferências de consentimento para um perfil de usuário - Liste as tags que foram reportadas no seu projeto - Informações da lista sobre dispositivos que atingem tags - Liste informações sobre atributos associados a usuários ou dispositivos - Lista as tarefas associadas ao seu projeto - Listas de promoções sincronizadas por motores de bônus conectados - Liste registros de histórico OTP com base em parâmetros de entrada específicos | - [Lista de Campanha](https://docs.xtremepush.com/reference/campaign-list) - [Lista de Dispositivos](https://docs.xtremepush.com/reference/device-list) - [Lista de Perfis](https://docs.xtremepush.com/reference/user-profile-list) - [Lista de Segmentos](https://docs.xtremepush.com/reference/segment-list) - [Lista de Listas](https://docs.xtremepush.com/reference/list-list) - [Item da Lista](https://docs.xtremepush.com/reference/list-items) - [Push de Listas](https://docs.xtremepush.com/reference/push-list) - [Dispositivos de Push de Lista](https://docs.xtremepush.com/reference/push-list-device) - [Assinatura do Perfil da Lista](https://docs.xtremepush.com/reference/user-profile-subscription) - [Atributo do Perfil da Lista](https://docs.xtremepush.com/reference/user-profile-attribute) - [Preferência de Consentimento do Perfil da Lista](https://docs.xtremepush.com/reference/user-profile-consent-preference) - [Tag de lista](https://docs.xtremepush.com/reference/tag-list) - [Acerto na etiqueta de lista](https://docs.xtremepush.com/reference/tag-list-hit) - [Cliente de atributos de lista](https://docs.xtremepush.com/reference/tag-list-attribute-client) - [Tarefa da lista](https://docs.xtremepush.com/reference/task-list) - [Promoções de Lista](https://docs.xtremepush.com/reference/list-promotions) - [Histórico da Lista OTP](https://docs.xtremepush.com/reference/otp-history-list) |
| Informações | - Obtenha informações sobre uma única campanha - Obtenha detalhes sobre um único dispositivo usando seu aplicativo - Obtenha informações em um perfil de usuário - Obtenha informações sobre um único segmento - Obtenha informações sobre uma lista de usuários únicos - Obtenha informações sobre tarefas de dados assíncronas, como importações ou exclusãos - Obtenha informações sobre uma única ação de notificação push - Obtenha informações sobre os registros OTP. | - [Informações da campanha](https://docs.xtremepush.com/reference/campaign-info) - [Informações do dispositivo](https://docs.xtremepush.com/reference/device-info) - [Informações do perfil](https://docs.xtremepush.com/reference/user-profile-info) - [Informações do segmento](https://docs.xtremepush.com/reference/segment-info) - [Informações da Lista](https://docs.xtremepush.com/reference/list-info) - [Informações da Tarefa](https://docs.xtremepush.com/v2025.6_2026.2_Anirudh/update/docs/set-scopes) - [Informações da Mensagem](https://docs.xtremepush.com/reference/push-info) - [Informações do OTP](https://docs.xtremepush.com/reference/otp-history-info) |

### Operações de Campanha

| Escopo | Permissões | Referência API |
| --- | --- | --- |
| Enviar | Envie uma única campanha | [Enviar](https://docs.xtremepush.com/reference/campaign-send) |
| Executar | Executar uma campanha | [Executar](https://docs.xtremepush.com/reference/campaign-execute) |
| Comece | Comece uma campanha pausada/parada | [Comece](https://docs.xtremepush.com/reference/campaign-start) |
| Pare | Campanha de parada e ativa | [Pare](https://docs.xtremepush.com/reference/campaign-stop) |
| Cronograma | Agende uma campanha |  |
| Expirar a Caixa de Entrada | Expirar uma campanha inteira na caixa de entrada que está no andamento | [Expirar a Caixa de Entrada](https://docs.xtremepush.com/reference/campaign-expire) |
| Remover Caixa de Entrada | Remover uma mensagem da caixa de entrada que já foi enviada | [Remover Caixa de Entrada](https://docs.xtremepush.com/reference/campaign-remove) |
| Cancelar Jornada | Fazer com que um usuário ou uma lista de usuários conclua uma jornada em múltiplas etapas, impedindo que recebam mais mensagens | [Cancelar Jornada](https://docs.xtremepush.com/reference/cancel-journey) |

### Operações de Ataque

| Escopo | Permissões | Referência API |
| --- | --- | --- |
| Tag | - Adicione uma tag ou atualize um atributo quando um evento ocorrer ou um atributo mudar fora do seu app - Adicione tags ou atualize atributos quando um evento ocorre ou um atributo muda fora do seu app | - [Hit Tag](https://docs.xtremepush.com/reference/tag-hit) - [Hit Tags](https://docs.xtremepush.com/reference/tag-hit-tags) |
| Evento | - Envie um evento em tempo real para o Xtremepush quando um evento ocorre em um sistema backend - Envie eventos em tempo real para o Xtremepush em lote quando eventos ocorrem em um sistema backend | - [Evento de sucesso](https://docs.xtremepush.com/reference/event-hit-event) - [Batch Hit](https://docs.xtremepush.com/reference/event-batch-hit) |

### Outras Operações

| Escopo | Permissões | Referência API |
| --- | --- | --- |
| Importação | - Criar novos perfis de usuário e/ou definir atributos para esses perfis - Importe/atualize os valores da lista de usuários que serão associados ao seu projeto. - Adicione/remova destinatários para/de uma lista de supressão. | - [Perfil de Importação](https://docs.xtremepush.com/reference/user-profile-import) - [Listas de importação](https://docs.xtremepush.com/reference/list-import) - [Listas de Supressão de Importação](https://docs.xtremepush.com/reference/suppression-list-import) |
| Exportação | Acione uma tarefa em segundo plano para exportar dados de dispositivo ou perfil para um segmento específico | [Extensão do Segmento de Gatilho](https://docs.xtremepush.com/reference/export-segments)t |
| Análise | - Informações de retorno sobre novos usuários ao longo de um determinado período de tempo - Informações de retorno sobre o total de sessões em um determinado período de tempo - Informações de retorno sobre sessões únicas em um determinado período de tempo - Retorne informações sobre o tempo total da sessão em um determinado período, a unidade é em segundos - Retorne informações sobre o tempo médio de sessão em um determinado período, a unidade é em segundos - Retorna novos usuários, total de sessões, sessões únicas, tempo total de sessões e tempo médio de sessão em uma única solicitação - Estatísticas de retorno de todas as campanhas ou de campanhas específicas - Informações de retorno em entradas de localização em um determinado período de tempo | - [Novos Usuários](https://docs.xtremepush.com/reference/analytics-new-users) - [Total de Sessões](https://docs.xtremepush.com/reference/analytics-total-sessions) - [Sessões Únicas](https://docs.xtremepush.com/reference/analytics-unique-sessions) - [Tempo Total das Sessões](https://docs.xtremepush.com/reference/analytics-unique-sessions) - [Duração média das sessões](https://docs.xtremepush.com/reference/analytics-average-sessions-time) - [Estatísticas](https://docs.xtremepush.com/reference/analytics-statistics) - [Estatísticas da campanha](https://docs.xtremepush.com/reference/analytics-campaigns-stats) - [Locações de sucesso](https://docs.xtremepush.com/reference/analytics-location-hits) |
| Baixar o Arquivo | Recupere um arquivo específico usando seu identificador único de arquivo. | [Baixar o arquivo por ID](https://docs.xtremepush.com/reference/download-file-by-id) |
| Ações de Integração | - Crie e envie senhas de uso único (OTPs) para os usuários para autenticação segura. - Envie seu próprio OTP para seus usuários - Valide senhas de uso único (OTPs) inseridas pelos usuários contra OTPs previamente gerados e armazenados. - Assine um cliente para atualizações esportivas em tempo real - Desassine um cliente das atualizações esportivas em tempo real | - [Geração OTP](https://docs.xtremepush.com/reference/otp-generate) - [Execução OTP](https://docs.xtremepush.com/reference/otp-execute) - [OTP Verify](https://docs.xtremepush.com/reference/otp-verify) - [Siga](https://docs.xtremepush.com/reference/realtime-sports-follow) - [Deixar de seguir](https://docs.xtremepush.com/reference/realtime-sports-unfollow) |
| Ações de Dados | - Exclua todos os dados pessoais de um perfil de usuário e de dispositivos associados ao perfil do usuário. - Excluir dados pessoais do dispositivo | - [Exclua Dados Pessoais](https://docs.xtremepush.com/reference/pii-deletion-delete-personal-data) - [Excluir Dados Pessoais do Dispositivo](https://docs.xtremepush.com/reference/pii-deletion-delete-device-personal-data) |