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

> ## Agent Instructions
> Install the Courier skill before writing code: `npx skills add trycourier/courier-skills`. It carries the verified SDK shapes and the rules you cannot get wrong.
> Authenticate every request with `Authorization: Bearer <API_KEY>`. A workspace has several environments and each has its own keys, which are plain `pk_` strings with no environment prefix. Start with Test.
> Send with `client.send.message`, the default import of the v7 Node SDK. Reference a template by its `nt_` id or its alias.
> A send accepts a bare Elemental element list, but storing content on a template requires the top-level elements wrapped in a channel element.
> Templates and journeys can be built in the Courier app or created through the API. Either way they live in the workspace and are referenced by ID when you send.
> The hosted MCP server is https://mcp.courier.com. For a briefing on what Courier is and when to use it, read https://www.courier.com/llms.txt.
> Prefer the Guides tab for how-do-I questions and the Docs tab for how-does-it-behave questions. The API reference lives under /api-reference.

# Send push with Beamer through Courier

> Connect Beamer with an API key, set its profile field, and override fields per send.

export const AppLink = ({href, children, name, bare}) => {
  const label = children || name || "Open in Courier";
  if (bare) {
    return <a href={href} target="_blank" rel="noreferrer">{label}</a>;
  }
  return <a className="cx-endpoint" data-kind="app" href={href} target="_blank" rel="noreferrer">
      <span className="cx-endpoint-label">{label}</span>
      <span className="cx-endpoint-method" aria-hidden="true">↗</span>
    </a>;
};

export const Doc = ({href, children, name, bare}) => {
  const label = children || name || href;
  if (bare) {
    return <a href={href}>{label}</a>;
  }
  return <a className="cx-endpoint" data-kind="doc" href={href}>
      <span className="cx-endpoint-label">{label}</span>
      <span className="cx-endpoint-method">DOC</span>
    </a>;
};

## Prerequisites

* [A Beamer account](https://www.getbeamer.com/)
* Your Beamer API key
* <Doc href="/docs/design/templates/overview">A template with a Beamer channel</Doc>
* A category in that template's Beamer channel settings

## Setup

<Steps>
  <Step title="Get your Beamer API key">
    In Beamer, open [settings](https://app.getbeamer.com/settings) and copy your API key.
  </Step>

  <Step title="Configure in Courier">
    Open the <AppLink href="https://app.courier.com/integrations/catalog/beamer">Beamer Integration</AppLink> in Courier, enter your API key, then click "Save."
  </Step>
</Steps>

## Profile requirements

Device tokens live on the user profile rather than on the send, so one profile can hold tokens for several devices and every push provider reads them from the same place. <Doc href="/docs/send/push/overview">Send push</Doc> covers the model.

No profile data is required for Beamer.

## Overrides

<Doc href="/docs/send/overrides#how-overrides-work">How overrides work</Doc> covers the two levels and which one wins. <Doc href="/docs/integrations/push/overview#channel-overrides">Push channel overrides</Doc> lists the fields every push provider takes.

Overrides change the request body Courier uses to send a push message. You can override these fields from Beamer's `postcreation` object ([documented in Beamer's API docs](https://www.getbeamer.com/api#definition-PostCreation)).

```json theme={null}
{
  "filter": "",
  "filterUserId": "",
  "filterUrl": "",
  "sendPushNotification": "",
  "publish": ""
}
```

This override delivers a post to a specific known user id.

<CodeGroup>
  ```javascript Node.js highlight={6-14} theme={null}
  const { requestId } = await courier.send.message({
    message: {
      template: "nt_01kx4h2jdafq8bk9aftxak4b40",
      to: {},
      providers: {
        beamer: {
          override: {
            body: {
              filterUserId: "user_123",
              sendPushNotification: "false",
              publish: "true",
            },
          },
        },
      },
    },
  });
  ```

  ```python Python highlight={6-14} theme={null}
  response = client.send.message(
      message={
          "template": "nt_01kx4h2jdafq8bk9aftxak4b40",
          "to": {},
          "providers": {
              "beamer": {
                  "override": {
                      "body": {
                          "filterUserId": "user_123",
                          "sendPushNotification": "false",
                          "publish": "true",
                      },
                  },
              },
          },
      },
  )
  ```

  ```bash cURL highlight={9-17} wrap theme={null}
  curl -X POST https://api.courier.com/send \
    -H "Authorization: Bearer $COURIER_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
      "message": {
        "template": "nt_01kx4h2jdafq8bk9aftxak4b40",
        "to": {},
        "providers": {
          "beamer": {
            "override": {
              "body": {
                "filterUserId": "user_123",
                "sendPushNotification": "false",
                "publish": "true"
              }
            }
          }
        }
      }
    }'
  ```

  ```ruby Ruby highlight={6-14} theme={null}
  response = courier.send_.message(
    message: {
      template: "nt_01kx4h2jdafq8bk9aftxak4b40",
      to: {},
      providers: {
        beamer: {
          override: {
            body: {
              filterUserId: "user_123",
              sendPushNotification: "false",
              publish: "true"
            }
          }
        }
      }
    }
  )
  ```

  ```go Go highlight={9-17} theme={null}
  response, err := client.Send.Message(context.TODO(), courier.SendMessageParams{
  	Message: courier.SendMessageParamsMessage{
  		To: courier.SendMessageParamsMessageToUnion{
  			OfUserRecipient: &shared.UserRecipientParam{
  			},
  		},
  		Template: courier.String("nt_01kx4h2jdafq8bk9aftxak4b40"),
  		Providers: shared.MessageProvidersParam{
  			"beamer": shared.MessageProvidersTypeParam{
  				Override: map[string]any{
  					"body": map[string]any{
  						"filterUserId": "user_123",
  						"sendPushNotification": "false",
  						"publish": "true",
  					},
  				},
  			},
  		},
  	},
  })
  ```

  ```java Java highlight={6-12} theme={null}
  SendMessageParams params = SendMessageParams.builder()
      .message(SendMessageParams.Message.builder()
          .to(UserRecipient.builder().build())
          .template("nt_01kx4h2jdafq8bk9aftxak4b40")
          .providers(MessageProviders.builder()
              .putAdditionalProperty("beamer", JsonValue.from(java.util.Map.of("override", java.util.Map.of(
                      "body", java.util.Map.of(
                          "filterUserId", "user_123",
                          "sendPushNotification", "false",
                          "publish", "true"
                      )
                  ))))
              .build())
          .build())
      .build();
  SendMessageResponse response = client.send().message(params);
  ```

  ```php PHP highlight={6-14} theme={null}
  $response = $client->send->message(
    message: [
      'template' => 'nt_01kx4h2jdafq8bk9aftxak4b40',
      'to' => [],
      'providers' => [
        'beamer' => [
          'override' => [
            'body' => [
              'filterUserId' => 'user_123',
              'sendPushNotification' => 'false',
              'publish' => 'true',
            ],
          ],
        ],
      ],
    ],
  );
  ```

  ```csharp C# highlight={9-25} theme={null}
  SendMessageParams parameters = new()
  {
      Message = new()
      {
          To = new UserRecipient {  },
          Template = "nt_01kx4h2jdafq8bk9aftxak4b40",
          Providers = new Dictionary<string, MessageProvidersType>()
          {
              {
                  "beamer",
                  new()
                  {
                      Override = JsonSerializer.Deserialize<Dictionary<string, JsonElement>>(
                          """
                          {
                            "body": {
                              "filterUserId": "user_123",
                              "sendPushNotification": "false",
                              "publish": "true"
                            }
                          }
                          """
                      ),
                  }
              },
          },
      },
  };

  var response = await client.Send.Message(parameters);
  ```

  ```bash CLI highlight={5} wrap theme={null}
  courier send message \
    --api-key "$COURIER_API_KEY" \
    --message.to '{}' \
    --message.template nt_01kx4h2jdafq8bk9aftxak4b40 \
    --message.providers '{"beamer": {"override": {"body": {"filterUserId": "user_123", "sendPushNotification": "false", "publish": "true"}}}}'
  ```

  ```text MCP theme={null}
  With Courier MCP, send my template to a known Beamer user id.
  ```
</CodeGroup>

## Provider details

```text theme={null}
beamer
```

Courier recommends routing to the channel. Naming this key in `routing.channels` instead is supported, and sends through just this provider.

<Card title="Send to a specific provider" icon="bullseye-arrow" href="/docs/send/send-to-a-provider" horizontal arrow="true">
  When that is worth doing, and what you give up: failover, channel priority, and providers you add later.
</Card>