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

# Scribe API use cases: manage teammates, audit signatures, measure ROI

> What teams build with the Scribe API: provision teammates you manage by hand, audit signature compliance, schedule campaigns, measure ROI, and export data.

The Scribe API turns email signature management into something you can automate and wire into the rest of your stack. Instead of clicking through the dashboard, you can provision the teammates you manage by hand, audit your whole team in one call, schedule banner campaigns, and pull engagement data into your own tools.

Every example below maps to endpoints you can browse in the sidebar. Pick the workflow that matches your goal, then follow the links to the exact requests.

## What you can build

<CardGroup cols={2}>
  <Card title="Manage teammates programmatically" icon="users">
    Create teammates and set their smart field values from your own records, for people you manage by hand rather than syncing a directory.
  </Card>

  <Card title="Automate onboarding and offboarding" icon="user-plus">
    Add a teammate, set their fields, and install the right signature the day they join. Remove them the day they leave.
  </Card>

  <Card title="Audit signature compliance" icon="clipboard-check">
    Check which templates are published and installed, and who they are assigned to, across your team.
  </Card>

  <Card title="Manage templates and folders as code" icon="layers">
    Create, update, publish, and organize signature templates programmatically, version controlled in your own repo.
  </Card>

  <Card title="Schedule marketing campaigns" icon="megaphone">
    Launch, pause, and resume promotional banners on a schedule, tied to your product or sales calendar.
  </Card>

  <Card title="Measure signature ROI" icon="chart-line">
    Pull views, clicks, and clickthrough rate over time, broken down by template, campaign, teammate, or country.
  </Card>

  <Card title="Export engagement to your warehouse" icon="database">
    Schedule a pull of analytics and push signature engagement into your data warehouse or BI tool.
  </Card>

  <Card title="Reconcile billing and seats" icon="receipt">
    Read your plan, seat count, and invoices to keep finance systems in step with your workspace.
  </Card>
</CardGroup>

## Manage teammates programmatically

If you manage teammates by hand instead of syncing a directory, the API is the programmatic version of the manual form and CSV upload. Create teammates and set their smart field values from your own records, so when someone joins, changes role, or leaves, you push the change and their signature follows.

<Note>
  Importing teammates from **Microsoft Entra ID** or **Google Workspace** is set up inside Scribe with OAuth, and that data flows one way, from your directory into Scribe. The API does not configure that sync or write back to synced directory fields, so use these endpoints for the teammates you manage manually. See [Connect Microsoft Entra ID](/en/teammates/connect-microsoft-entra-id) and the [Teammates overview](/en/teammates/teammates-overview).
</Note>

<Steps>
  <Step title="Read your smart fields">
    List your [smart fields](/en/smart-fields) to get the IDs you will populate, like job title or phone number.

    ```bash theme={null}
    curl https://api.scribe-mail.com/v1/smart_fields \
      -H "Authorization: Bearer YOUR_API_KEY"
    ```
  </Step>

  <Step title="Create or update each teammate">
    Send each person's email and smart field values. Run this whenever a record changes in your own system to keep Scribe in step.

    ```bash theme={null}
    curl https://api.scribe-mail.com/v1/teammates \
      -H "Authorization: Bearer YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "teammate": {
          "email": "jordan@acme.com",
          "smart_fields": [
            { "smart_field_id": "8e0d4b1a-2c3d-4f5a-9b6d-7c2e9a3f1c2e", "value": "Account Executive" },
            { "smart_field_id": "a1b2c3d4-5e6f-4a8b-9c0d-1e2f3a4b5c6d", "value": "+1 555 0142" }
          ]
        }
      }'
    ```
  </Step>

  <Step title="Assign and install the signature">
    Install a published template so it deploys to the teammate's mailbox.

    ```bash theme={null}
    curl https://api.scribe-mail.com/v1/signatures/SIGNATURE_ID/install \
      -X POST \
      -H "Authorization: Bearer YOUR_API_KEY"
    ```
  </Step>

  <Step title="Offboard when someone leaves">
    Delete the teammate to stop their signature from deploying.

    ```bash theme={null}
    curl https://api.scribe-mail.com/v1/teammates/TEAMMATE_ID \
      -X DELETE \
      -H "Authorization: Bearer YOUR_API_KEY"
    ```
  </Step>
</Steps>

<Tip>
  Run this on a schedule (a nightly job from your own system) so the teammates you manage by hand never drift from your records.
</Tip>

## Audit signatures across your team

Answer compliance questions in one pass: which templates are live, who they reach, and whether any integration is failing. List signatures to read their publish and installation status, then list each signature's recipient emails to confirm coverage.

```bash theme={null}
# Every signature, with publish and install status
curl https://api.scribe-mail.com/v1/signatures \
  -H "Authorization: Bearer YOUR_API_KEY"

# Who a given signature is assigned to
curl https://api.scribe-mail.com/v1/signatures/SIGNATURE_ID/emails \
  -H "Authorization: Bearer YOUR_API_KEY"
```

To check the systems feeding your workspace, list active [integrations](/en/integrations-overview) and their synced entities. This is how you catch a directory sync that has gone stale before it shows up in someone's signature.

## Measure signature performance and ROI

Signatures are a channel, so treat them like one. The analytics endpoints return views, clicks, and clickthrough rate, which you can trend over time or break down by dimension.

```bash theme={null}
# Views and clicks over time for one template, week by week
curl "https://api.scribe-mail.com/v1/analytics/overview\
?start_date=2026-01-01&end_date=2026-03-31&interval=week\
&signature_template_id=SIGNATURE_ID" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Rank templates by clickthrough rate
curl "https://api.scribe-mail.com/v1/analytics/breakdown\
?dimension=signature_template&order_by=clickthrough_rate&order=desc\
&start_date=2026-01-01&end_date=2026-03-31" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

Break down by `marketing_campaign` to compare banner campaigns, by `teammate` to find your top performers, or by `country` to see where your signatures land. See [Analytics](/en/analytics-overview) for what each metric means.

## Export engagement to your warehouse

Because the breakdown endpoint paginates and accepts a date range, it doubles as an export. Schedule a job that pulls each day's engagement by the dimension you care about, then load it into your warehouse or BI tool to power retargeting and reporting with real audience signals.

```bash theme={null}
# Daily engagement by country, page through with page and limit
curl "https://api.scribe-mail.com/v1/analytics/breakdown\
?dimension=country&start_date=2026-06-01&end_date=2026-06-01&limit=100" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

See [Pagination](/api-reference/pagination) for paging through large result sets.

## Automate marketing campaigns

Drive banner campaigns from your product or sales calendar. Create a campaign, schedule it to go live, then pause or resume it without touching the dashboard.

```bash theme={null}
# Schedule a campaign to start
curl https://api.scribe-mail.com/v1/marketing_campaigns/CAMPAIGN_ID/schedule \
  -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

# Pause it, then resume later
curl https://api.scribe-mail.com/v1/marketing_campaigns/CAMPAIGN_ID/pause \
  -X POST -H "Authorization: Bearer YOUR_API_KEY"
```

Pair this with the analytics endpoints to measure each campaign as it runs.

## Operations and finance

Keep your own systems in step with your workspace. Read the workspace to get your current plan and seat count, and list financial documents to reconcile invoices in your finance stack.

```bash theme={null}
# Plan and seat count
curl https://api.scribe-mail.com/v1/workspace \
  -H "Authorization: Bearer YOUR_API_KEY"

# Invoices and other financial documents
curl https://api.scribe-mail.com/v1/financial_documents \
  -H "Authorization: Bearer YOUR_API_KEY"
```

## Tips for building reliably

<CardGroup cols={2}>
  <Card title="Scope keys to the job" icon="key" href="/api-reference/authentication">
    Give each integration its own API key, scoped to only the resources it needs.
  </Card>

  <Card title="Page through everything" icon="list" href="/api-reference/pagination">
    List endpoints are page-based. Increment `page` until `has_more` is false.
  </Card>

  <Card title="Handle errors" icon="triangle-alert" href="/api-reference/errors">
    Check status codes and the JSON error envelope so a sync fails loudly, not silently.
  </Card>

  <Card title="Build content correctly" icon="layers" href="/api-reference/signature-content">
    Signatures and banners use a block tree. Learn the format before you create templates.
  </Card>
</CardGroup>

## Next steps

<CardGroup cols={2}>
  <Card title="Make your first request" icon="play" href="/api-reference/introduction">
    The base URL, the auth header, and a first call you can run now.
  </Card>

  <Card title="Prefer plain English?" icon="bot" href="/en/ai-agents">
    The Scribe MCP server runs these same workflows from your AI assistant.
  </Card>
</CardGroup>