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

# API Key Scopes

> Permissions for contacts, tags, topics, segments, and campaigns.

<Tip>
  Five families: **`contacts`**, **`tags`**, **`topics`**, **`segments`**, **`campaigns`**. Campaigns also need **send** scopes per channel (`whatsapp:send`, `sms:send`, …).
</Tip>

Each **scope** unlocks one type of Contacts operation. Use only what your integration needs.

## How to send the key

**Recommended**

```http theme={null}
Authorization: Bearer sk_live_your_key_here
```

**Alternative**

```http theme={null}
x-api-key: sk_live_your_key_here
```

<Info>
  The API Key belongs to **one** workspace. You cannot access another workspace with the same key.
</Info>

## Common combinations

<CardGroup cols={2}>
  <Card title="Read database only" icon="magnifying-glass">
    `contacts:read`, `tags:read`
  </Card>

  <Card title="Sync CRM" icon="rotate">
    `contacts:read`, `contacts:create`, `contacts:update`, `tags:read`, `tags:create`
  </Card>

  <Card title="Campaigns via API" icon="paper-plane">
    `campaigns:read`, `campaigns:create`, `campaigns:run` + channel send scopes
  </Card>

  <Card title="Full management" icon="address-book">
    All `contacts:*`, `tags:*`, `topics:*`, `segments:*`, `campaigns:*`
  </Card>
</CardGroup>

<Warning>
  An **empty** scope list on create = **ADMIN** access. Always restrict in production.
</Warning>

## Contacts (`contacts:*`)

<AccordionGroup>
  <Accordion title="contacts:read">
    List and get contact by ID.
  </Accordion>

  <Accordion title="contacts:create">
    Create contact (phone and/or email required).
  </Accordion>

  <Accordion title="contacts:update">
    Edit record, tags, and fields.
  </Accordion>

  <Accordion title="contacts:delete">
    Delete contact.
  </Accordion>
</AccordionGroup>

## Tags (`tags:*`)

<AccordionGroup>
  <Accordion title="tags:read">
    List and get tag.
  </Accordion>

  <Accordion title="tags:create">
    Create reusable label.
  </Accordion>

  <Accordion title="tags:update">
    Rename tag.
  </Accordion>

  <Accordion title="tags:delete">
    Delete tag.
  </Accordion>
</AccordionGroup>

## Topics (`topics:*`)

Marketing **theme** consent. Same as **Audience → Topics** in the dashboard.

<AccordionGroup>
  <Accordion title="topics:read">
    List and get topic.
  </Accordion>

  <Accordion title="topics:create">
    Create topic with stable slug.
  </Accordion>

  <Accordion title="topics:update">
    Edit name, description, and default opt-in.
  </Accordion>

  <Accordion title="topics:delete">
    Delete topic.
  </Accordion>
</AccordionGroup>

## Segments (`segments:*`)

Audiences with **rules** (tags, fields, topics, marketing). Includes **preview**.

<AccordionGroup>
  <Accordion title="segments:read">
    List, get, and **preview** (paginated audience sample).
  </Accordion>

  <Accordion title="segments:create">
    Create segment with JSON `version: 1`, `match`, `rules`.
  </Accordion>

  <Accordion title="segments:update">
    Edit segment rules.
  </Accordion>

  <Accordion title="segments:delete">
    Delete segment.
  </Accordion>
</AccordionGroup>

## Campaigns (`campaigns:*`)

<AccordionGroup>
  <Accordion title="campaigns:read">
    List, get, **statistics**, and **recipients** per run.
  </Accordion>

  <Accordion title="campaigns:create">
    Create campaign (optionally with `scheduledFor`).
  </Accordion>

  <Accordion title="campaigns:update">
    Edit campaign and **cancel** (DRAFT/SCHEDULED → CANCELLED).
  </Accordion>

  <Accordion title="campaigns:delete">
    Delete campaign.
  </Accordion>

  <Accordion title="campaigns:run">
    **Dispatch now** (Run), queues sends on campaign channels.
  </Accordion>
</AccordionGroup>

<Warning>
  Running a campaign requires `campaigns:run` **and** send scopes for each channel when the queue processes messages.
</Warning>

## Next steps

* [Quick Start](/en/contacts-api/como-funciona/quick-start)
* [Introduction](/en/contacts-api/como-funciona/introducao)
* [Campaigns](/en/contacts-api/como-funciona/campanhas-no-painel)