> ## 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 Intercom messages through Courier

> Connect Intercom with an access token and send in-app messages by Intercom user ID.

export const Endpoint = ({method, path, name, href, children, bare}) => {
  const verb = String(method || "").toUpperCase();
  const title = verb + " " + path;
  const label = children || name || path;
  if (bare) {
    return href ? <a href={href}><code>{title}</code></a> : <code>{title}</code>;
  }
  if (!href) {
    return <span className="cx-endpoint" data-method={verb} title={title}>
        <span className="cx-endpoint-label">{label}</span>
        <span className="cx-endpoint-method">{verb}</span>
      </span>;
  }
  return <a className="cx-endpoint" data-method={verb} href={href} title={title}>
      <span className="cx-endpoint-label">{label}</span>
      <span className="cx-endpoint-method">{verb}</span>
    </a>;
};

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

* Your Intercom access token
* An Intercom admin or bot user ID

## Setup

<Steps>
  <Step title="Get your Intercom access token">
    In Intercom, follow [the authentication guide](https://developers.intercom.com/docs/build-an-integration/learn-more/authentication) to create an access token.
  </Step>

  <Step title="Configure in Courier">
    Install the <AppLink href="https://app.courier.com/integrations/catalog/intercom">Intercom integration</AppLink> in Courier and enter your access token and user ID.
  </Step>
</Steps>

## Profile requirements

Intercom addresses the recipient by user ID, nested under `intercom.to.id` on the profile. Courier assumes the user is of type `user`. Store it once with <Endpoint method="POST" path="/profiles/{user_id}" name="Create a Profile" href="/docs/api-reference/user-profiles/create-a-profile" />, which merges into the profile and creates it if it does not exist:

<CodeGroup>
  ```javascript Node.js highlight={3-7} theme={null}
  const profile = await client.profiles.create('user_123', {
    profile: {
      intercom: {
        to: {
          id: 'INTERCOM_USER_ID',
        },
      },
    },
  });
  ```

  ```python Python highlight={4-8} theme={null}
  profile = client.profiles.create(
      user_id="user_123",
      profile={
          "intercom": {
              "to": {
                  "id": "INTERCOM_USER_ID",
              },
          },
      },
  )
  ```

  ```bash cURL highlight={7-11} theme={null}
  curl --request POST \
    --url https://api.courier.com/profiles/user_123 \
    --header "Authorization: Bearer $COURIER_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{
      "profile": {
        "intercom": {
          "to": {
            "id": "INTERCOM_USER_ID"
          }
        }
      }
    }'
  ```

  ```ruby Ruby highlight={4-8} theme={null}
  profile = courier.profiles.create(
    "user_123",
    profile: {
      intercom: {
        to: {
          id: "INTERCOM_USER_ID"
        }
      }
    }
  )
  ```

  ```go Go highlight={6-10} theme={null}
  profile, err := client.Profiles.New(
  	context.TODO(),
  	"user_123",
  	courier.ProfileNewParams{
  		Profile: map[string]any{
  			"intercom": map[string]any{
  				"to": map[string]any{
  					"id": "INTERCOM_USER_ID",
  				},
  			},
  		},
  	},
  )
  ```

  ```java Java highlight={4-6} theme={null}
  ProfileCreateParams params = ProfileCreateParams.builder()
      .userId("user_123")
      .profile(ProfileCreateParams.Profile.builder()
          .putAdditionalProperty("intercom", JsonValue.from(java.util.Map.of(
              "to", java.util.Map.of(
                  "id", "INTERCOM_USER_ID"))))
          .build())
      .build();
  ProfileCreateResponse profile = client.profiles().create(params);
  ```

  ```php PHP highlight={2-6} theme={null}
  $profile = $client->profiles->create('user_123', profile: [
    'intercom' => [
      'to' => [
        'id' => 'INTERCOM_USER_ID',
      ],
    ],
  ]);
  ```

  ```csharp C# highlight={7-11} theme={null}
  ProfileCreateParams parameters = new()
  {
      UserID = "user_123",
      Profile = JsonSerializer.Deserialize<Dictionary<string, JsonElement>>(
          """
          {
            "intercom": {
              "to": {
                "id": "INTERCOM_USER_ID"
              }
            }
          }
          """
      ),
  };
  var profile = await client.Profiles.Create(parameters);
  ```

  ```bash CLI highlight={4} wrap theme={null}
  courier profiles create \
    --api-key "$COURIER_API_KEY" \
    --user-id user_123 \
    --profile '{"intercom":{"to":{"id":"INTERCOM_USER_ID"}}}'
  ```

  ```text MCP theme={null}
  With Courier MCP, save the Intercom user id INTERCOM_USER_ID on user_123.
  ```
</CodeGroup>

Then send to `user_id` and Courier resolves the address.

For a one-off with no stored profile, pass it inline instead: `"to": { "intercom": { "to": { "id": "INTERCOM_USER_ID" } } }`.

<CardGroup cols={1}>
  <Card title="Send by user id" icon="user" href="/docs/recipients/overview#send-by-user-id">
    The call in every language, and the rest of the profile object.
  </Card>
</CardGroup>

## Send to a recipient

<Tabs>
  <Tab title="Send to user id">
    Courier reads `intercom` off the saved profile, so preferences apply and the value can change without touching this code.

    <CodeGroup>
      ```javascript Node.js highlight={4} theme={null}
      const { requestId } = await courier.send.message({
        message: {
          to: {
            user_id: "user_123",
          },
          template: "nt_01kx4h2jdafq8bk9aftxak4b40",
        },
      });
      ```

      ```python Python highlight={4} theme={null}
      response = client.send.message(
          message={
              "to": {
                  "user_id": "user_123",
              },
              "template": "nt_01kx4h2jdafq8bk9aftxak4b40",
          },
      )
      ```

      ```bash cURL highlight={7} wrap theme={null}
      curl -X POST https://api.courier.com/send \
        -H "Authorization: Bearer $COURIER_API_KEY" \
        -H "Content-Type: application/json" \
        -d '{
          "message": {
            "to": {
              "user_id": "user_123"
            },
            "template": "nt_01kx4h2jdafq8bk9aftxak4b40"
          }
        }'
      ```

      ```ruby Ruby highlight={4} theme={null}
      response = courier.send_.message(
        message: {
          to: {
            user_id: "user_123"
          },
          template: "nt_01kx4h2jdafq8bk9aftxak4b40"
        }
      )
      ```

      ```go Go highlight={5} theme={null}
      response, err := client.Send.Message(context.TODO(), courier.SendMessageParams{
      	Message: courier.SendMessageParamsMessage{
      		To: courier.SendMessageParamsMessageToUnion{
      			OfUserRecipient: &shared.UserRecipientParam{
      				UserID: courier.String("user_123"),
      			},
      		},
      		Template: courier.String("nt_01kx4h2jdafq8bk9aftxak4b40"),
      	},
      })
      ```

      ```java Java highlight={3} theme={null}
      SendMessageParams params = SendMessageParams.builder()
          .message(SendMessageParams.Message.builder()
              .to(UserRecipient.builder().userId("user_123").build())
              .template("nt_01kx4h2jdafq8bk9aftxak4b40")
              .build())
          .build();
      SendMessageResponse response = client.send().message(params);
      ```

      ```php PHP highlight={4} theme={null}
      $response = $client->send->message(
        message: [
          'to' => [
            'user_id' => 'user_123',
          ],
          'template' => 'nt_01kx4h2jdafq8bk9aftxak4b40',
        ],
      );
      ```

      ```csharp C# highlight={5} theme={null}
      SendMessageParams parameters = new()
      {
          Message = new()
          {
              To = new UserRecipient { UserID = "user_123" },
              Template = "nt_01kx4h2jdafq8bk9aftxak4b40",
          },
      };

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

      ```bash CLI highlight={3} wrap theme={null}
      courier send message \
        --api-key "$COURIER_API_KEY" \
        --message.to '{"user_id": "user_123"}' \
        --message.template nt_01kx4h2jdafq8bk9aftxak4b40
      ```

      ```text MCP theme={null}
      With Courier MCP, send my template to user_123 by email.
      ```
    </CodeGroup>
  </Tab>

  <Tab title="Send to `intercom`">
    Pass it inline instead and nothing is stored. Swap this `to` object into the call on the other tab.

    <CodeGroup>
      ```javascript Node.js highlight={5-9} theme={null}
      const { requestId } = await courier.send.message({
        message: {
          // A provider recipient is a profile field, so it sits outside the typed union.
          to: {
            intercom: {
              to: {
                id: "INTERCOM_USER_ID",
              },
            },
          } as any,
          template: "nt_01kx4h2jdafq8bk9aftxak4b40",
        },
      });
      ```

      ```python Python highlight={4-8} theme={null}
      response = client.send.message(
          message={
              "to": {
                  "intercom": {
                      "to": {
                          "id": "INTERCOM_USER_ID",
                      },
                  },
              },
              "template": "nt_01kx4h2jdafq8bk9aftxak4b40",
          },
      )
      ```

      ```bash cURL highlight={7-11} wrap theme={null}
      curl -X POST https://api.courier.com/send \
        -H "Authorization: Bearer $COURIER_API_KEY" \
        -H "Content-Type: application/json" \
        -d '{
          "message": {
            "to": {
              "intercom": {
                "to": {
                  "id": "INTERCOM_USER_ID"
                }
              }
            },
            "template": "nt_01kx4h2jdafq8bk9aftxak4b40"
          }
        }'
      ```

      ```ruby Ruby highlight={4-8} theme={null}
      response = courier.send_.message(
        message: {
          to: {
            intercom: {
              to: {
                id: "INTERCOM_USER_ID"
              }
            }
          },
          template: "nt_01kx4h2jdafq8bk9aftxak4b40"
        }
      )
      ```

      ```go Go highlight={2-4} theme={null}
      // A provider recipient is a profile field, so it sits outside the typed union.
      to := param.Override[shared.UserRecipientParam](
      	json.RawMessage(`{"intercom": {"to": {"id": "INTERCOM_USER_ID"}}}`),
      )

      response, err := client.Send.Message(context.TODO(), courier.SendMessageParams{
      	Message: courier.SendMessageParamsMessage{
      		To: courier.SendMessageParamsMessageToUnion{OfUserRecipient: &to},
      		Template: courier.String("nt_01kx4h2jdafq8bk9aftxak4b40"),
      	},
      })
      ```

      ```java Java highlight={3-5} theme={null}
      // A provider recipient is a profile field, so it sits outside the typed union.
      UserRecipient to = UserRecipient.builder()
          .putAdditionalProperty("intercom", JsonValue.from(Map.of(
                  "to", Map.of(
                      "id", "INTERCOM_USER_ID"))))
          .build();

      client.send().message(SendMessageParams.builder()
          .message(SendMessageParams.Message.builder()
              .to(to)
              .template("nt_01kx4h2jdafq8bk9aftxak4b40")
              .build())
          .build());
      ```

      ```php PHP highlight={4-8} theme={null}
      $response = $client->send->message(
        message: [
          'to' => [
            'intercom' => [
              'to' => [
                'id' => 'INTERCOM_USER_ID',
              ],
            ],
          ],
          'template' => 'nt_01kx4h2jdafq8bk9aftxak4b40',
        ],
      );
      ```

      ```csharp C# highlight={3-5} theme={null}
      // A provider recipient is a profile field, so it sits outside the typed union.
      UserRecipient to = UserRecipient.FromRawUnchecked(
          JsonSerializer.Deserialize<Dictionary<string, JsonElement>>(
              """{"intercom": {"to": {"id": "INTERCOM_USER_ID"}}}"""
          )
      );

      var response = await client.Send.Message(new() { Message = new() { To = to, Template = "nt_01kx4h2jdafq8bk9aftxak4b40" } });
      ```

      ```bash CLI highlight={3} wrap theme={null}
      courier send message \
        --api-key "$COURIER_API_KEY" \
        --message.to '{"intercom": {"to": {"id": "INTERCOM_USER_ID"}}}' \
        --message.template nt_01kx4h2jdafq8bk9aftxak4b40
      ```

      ```text MCP theme={null}
      With Courier MCP, send my template to the Intercom user INTERCOM_USER_ID.
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## Overrides

<Doc href="/docs/send/overrides#how-overrides-work">How overrides work</Doc> covers the two levels and which one wins.

A provider override changes what Courier sends as an Intercom Message. Overrides are deep-merged into the request: fields you set replace their counterparts, and everything you leave out is still sent. You can override the message body and the From User ID. This example overrides both:

<CodeGroup>
  ```javascript Node.js highlight={5-9,12-21} theme={null}
  const { requestId } = await courier.send.message({
    message: {
      template: "nt_01kx4h2jdafq8bk9aftxak4b40",
      to: {
        intercom: {
          to: {
            id: "INTERCOM_USER_ID",
          },
        },
      },
      providers: {
        intercom: {
          override: {
            body: {
              body: "I overrode this message",
              from: {
                id: "012345",
              },
            },
          },
        },
      },
    },
  });
  ```

  ```python Python highlight={5-9,12-21} theme={null}
  response = client.send.message(
      message={
          "template": "nt_01kx4h2jdafq8bk9aftxak4b40",
          "to": {
              "intercom": {
                  "to": {
                      "id": "INTERCOM_USER_ID",
                  },
              },
          },
          "providers": {
              "intercom": {
                  "override": {
                      "body": {
                          "body": "I overrode this message",
                          "from": {
                              "id": "012345",
                          },
                      },
                  },
              },
          },
      },
  )
  ```

  ```bash cURL highlight={8-12,15-24} 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": {
          "intercom": {
            "to": {
              "id": "INTERCOM_USER_ID"
            }
          }
        },
        "providers": {
          "intercom": {
            "override": {
              "body": {
                "body": "I overrode this message",
                "from": {
                  "id": "012345"
                }
              }
            }
          }
        }
      }
    }'
  ```

  ```ruby Ruby highlight={5-9,12-21} theme={null}
  response = courier.send_.message(
    message: {
      template: "nt_01kx4h2jdafq8bk9aftxak4b40",
      to: {
        intercom: {
          to: {
            id: "INTERCOM_USER_ID"
          }
        }
      },
      providers: {
        intercom: {
          override: {
            body: {
              body: "I overrode this message",
              from: {
                id: "012345"
              }
            }
          }
        }
      }
    }
  )
  ```

  ```go Go highlight={4-8,16-25} theme={null}
  // This provider addresses the recipient with fields outside the typed
  // UserRecipient model, so pass the recipient as raw JSON.
  to := param.Override[shared.UserRecipientParam](json.RawMessage(`{
    "intercom": {
      "to": {
        "id": "INTERCOM_USER_ID"
      }
    }
  }`))

  response, err := client.Send.Message(context.TODO(), courier.SendMessageParams{
  	Message: courier.SendMessageParamsMessage{
  		To: courier.SendMessageParamsMessageToUnion{OfUserRecipient: &to},
  		Template: courier.String("nt_01kx4h2jdafq8bk9aftxak4b40"),
  		Providers: shared.MessageProvidersParam{
  			"intercom": shared.MessageProvidersTypeParam{
  				Override: map[string]any{
  					"body": map[string]any{
  						"body": "I overrode this message",
  						"from": map[string]any{
  							"id": "012345",
  						},
  					},
  				},
  			},
  		},
  	},
  })
  ```

  ```java Java highlight={6-10,14-21} theme={null}
  SendMessageParams params = SendMessageParams.builder()
      .message(SendMessageParams.Message.builder()
          // This provider addresses the recipient with fields outside the
          // typed UserRecipient model, so pass them as additional properties.
          .to(UserRecipient.builder()
              .putAdditionalProperty("intercom", JsonValue.from(java.util.Map.of(
                  "to", java.util.Map.of(
                      "id", "INTERCOM_USER_ID"
                  )
              )))
              .build())
          .template("nt_01kx4h2jdafq8bk9aftxak4b40")
          .providers(MessageProviders.builder()
              .putAdditionalProperty("intercom", JsonValue.from(java.util.Map.of("override", java.util.Map.of(
                      "body", java.util.Map.of(
                          "body", "I overrode this message",
                          "from", java.util.Map.of(
                              "id", "012345"
                          )
                      )
                  ))))
              .build())
          .build())
      .build();
  SendMessageResponse response = client.send().message(params);
  ```

  ```php PHP highlight={5-9,12-21} theme={null}
  $response = $client->send->message(
    message: [
      'template' => 'nt_01kx4h2jdafq8bk9aftxak4b40',
      'to' => [
        'intercom' => [
          'to' => [
            'id' => 'INTERCOM_USER_ID',
          ],
        ],
      ],
      'providers' => [
        'intercom' => [
          'override' => [
            'body' => [
              'body' => 'I overrode this message',
              'from' => [
                'id' => '012345',
              ],
            ],
          ],
        ],
      ],
    ],
  );
  ```

  ```csharp C# highlight={11-15,23-40} theme={null}
  SendMessageParams parameters = new()
  {
      Message = new()
      {
          // This provider addresses the recipient with fields outside the
          // typed UserRecipient model, so build it from raw JSON.
          To = UserRecipient.FromRawUnchecked(
              JsonSerializer.Deserialize<Dictionary<string, JsonElement>>(
                  """
                  {
                    "intercom": {
                      "to": {
                        "id": "INTERCOM_USER_ID"
                      }
                    }
                  }
                  """
              )
          ),
          Template = "nt_01kx4h2jdafq8bk9aftxak4b40",
          Providers = new Dictionary<string, MessageProvidersType>()
          {
              {
                  "intercom",
                  new()
                  {
                      Override = JsonSerializer.Deserialize<Dictionary<string, JsonElement>>(
                          """
                          {
                            "body": {
                              "body": "I overrode this message",
                              "from": {
                                "id": "012345"
                              }
                            }
                          }
                          """
                      ),
                  }
              },
          },
      },
  };

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

  ```bash CLI highlight={3,5} wrap theme={null}
  courier send message \
    --api-key "$COURIER_API_KEY" \
    --message.to '{"intercom": {"to": {"id": "INTERCOM_USER_ID"}}}' \
    --message.template nt_01kx4h2jdafq8bk9aftxak4b40 \
    --message.providers '{"intercom": {"override": {"body": {"body": "I overrode this message", "from": {"id": "012345"}}}}}'
  ```

  ```text MCP theme={null}
  With Courier MCP, send my template to this Intercom contact with a body override.
  ```
</CodeGroup>

Other supported overrides are documented in the [Intercom API reference](https://developers.intercom.com/intercom-api-reference/reference#admin-initiated-conversation).

## Provider details

```text theme={null}
intercom
```

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>