Send an Inbox Message

Send an Inbox message using the Send API, including inbox as a routing channel. Routing channels control the delivery method for a message. Other channels include email, SMS and push.

Sending to the Inbox channel requires the Courier Inbox provider to be added to your workspace. In your workspace navigate to Integrations > Add Integration > Inbox > Courier to add the provider.

In the example below, we call the Send API to send a message to a user’s Inbox with variable interpolation.

curl -X POST https://api.courier.com/send \
  -H "Authorization: Bearer YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "message": {
      "to": {
        "user_id": "example_user"
      },
      "content": {
        "title": "Welcome, {{ name }}!",
        "body": "Thanks for signing up."
      },
      "data": {
        "name": "Nomen Nescio"
      },
      "routing": {
        "method": "single",
        "channels": ["inbox"]
      }
    }
  }'

const { requestId } = await courier.send({
  message: {
    to: { user_id: "example_user" },
    content: {
      title: "Welcome, {{ name }}!",
      body: "Thanks for signing up."
    },
    data: {
      name: "Nomen Nescio"
    },
    routing: {
      method: "single",
      channels: ["inbox"]
    }
  }
});

response = client.send(
  message=courier.ContentMessage(
    to=courier.UserRecipient(user_id="example_user"),
    content=courier.ElementalContentSugar(
      title="Welcome, {{ name }}!",
      body="Thanks for signing up."
    ),
    data={"name": "Nomen Nescio"},
    routing=courier.Routing(method="single", channels=["inbox"])
  )
)

res = client.send({
  message: {
    to: { user_id: "example_user" },
    content: {
      title: "Welcome, {{ name }}!",
      body: "Thanks for signing up."
    },
    data: {
      name: "Nomen Nescio"
    },
    routing: {
      method: "single",
      channels: ["inbox"]
    }
  }
})

$result = $courier->send(
  (object) [
    'to' => [
      'user_id' => "example_user"
    ],
    'content' => [
      'title' => "Welcome, {{ name }}!",
      'body' => "Thanks for signing up."
    ],
    'data' => [
      'name' => "Nomen Nescio"
    ],
    'routing' => [
      'method' => "single",
      'channels' => ["inbox"]
    ]
  ]
);

courier.send(SendMessageRequest.builder()
  .message(Message.of(TemplateMessage.builder()
    .to(MessageRecipient.of(Recipient.of(UserRecipient.builder()
      .userId("example_user")
      .build())))
    .content(ContentMessage.builder()
      .title("Welcome, {{ name }}!")
      .body("Thanks for signing up.")
      .build())
    .data(Map.of("name", "Nomen Nescio"))
    .routing(Routing.builder()
      .method("single")
      .channels(List.of("inbox"))
      .build())
    .build()))
  .build());

requestID, err := client.SendMessage(
  context.Background(),
  courier.SendMessageRequestBody{
    Message: map[string]interface{}{
      "to": map[string]string{
        "user_id": "example_user",
      },
      "content": map[string]string{
        "title": "Welcome, {{ name }}!",
        "body": "Thanks for signing up.",
      },
      "data": map[string]string{
        "name": "Nomen Nescio",
      },
      "routing": map[string]interface{}{
        "method": "single",
        "channels": []string{"inbox"},
      },
    },
  },
)

if err != nil {
  log.Fatal(err)
}
log.Printf("Message sent! Request ID: %s", requestID)

try 
{
  var response = await courier.SendAsync(
    new SendMessageRequest 
    {
      Message = new Message 
      {
        To = new Recipient 
        {
          UserId = "example_user"
        },
        Content = new MessageContent 
        {
          Title = "Welcome, {{ name }}!",
          Body = "Thanks for signing up."
        },
        Data = new Dictionary<string, object> 
        {
          { "name", "Nomen Nescio" }
        },
        Routing = new MessageRouting 
        {
          Method = "single",
          Channels = new[] { "inbox" }
        }
      }
    });

  Console.WriteLine($"Message sent! Request ID: {response.RequestId}");
}
catch (CourierException e)
{
  Console.WriteLine($"Error: {e.Message}");
  Console.WriteLine($"Status Code: {e.StatusCode}");
}

Passing `data` with an Inbox message

If you provide information in the data field, it will be passed with the inbox or push message to the SDK. Data that is referenced in your content payload or in a template (like {{ name }} in the example above), will be interpolated. Data that is not referenced will still be passed through with the message. This can be particularly useful for deep linking, opening a particular view in your app from a link or push notification.

Using Courier Elemental Syntax

Inbox SDKs support a subset of Elemental syntax. Elemental is a JSON-based templating format for composing cross-platform notifications.

Element	Web	iOS	Android
Title
Body
Text
Action

Check out the full list of elements for syntax and examples.

Send Using A Template

You can create a notification template using the Notification Designer. After you create a template (or edit an existing one), add a new channel and select “Inbox”. This will provide you with a blank template that you can use to customize the content that will delivered with that notification. When calling the API, replace the content field with a template field set to the ID of the template you created above.

curl -X POST https://api.courier.com/send \
  -H "Authorization: Bearer YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "message": {
      "to": {
        "user_id": "example_user"
      },
      "template": "TEMPLATE_ID",
      "data": {
        "name": "Nomen Nescio"
      },
      "routing": {
        "method": "single",
        "channels": ["inbox"]
      }
    }
  }'

const { requestId } = await courier.send({
  message: {
    to: { user_id: "example_user" },
    template: "TEMPLATE_ID",
    data: {
      name: "Nomen Nescio"
    },
    routing: {
      method: "single",
      channels: ["inbox"]
    }
  }
});

response = client.send(
  message=courier.TemplateMessage(
    to=courier.UserRecipient(user_id="example_user"),
    template="TEMPLATE_ID",
    data={"name": "Nomen Nescio"},
    routing=courier.Routing(method="single", channels=["inbox"])
  )
)

res = client.send({
  message: {
    to: { user_id: "example_user" },
    template: "TEMPLATE_ID",
    data: {
      name: "Nomen Nescio"
    },
    routing: {
      method: "single",
      channels: ["inbox"]
    }
  }
})

$result = $courier->send(
  (object) [
    'to' => [
      'user_id' => "example_user"
    ],
    'template' => "TEMPLATE_ID",
    'data' => [
      'name' => "Nomen Nescio"
    ],
    'routing' => [
      'method' => "single",
      'channels' => ["inbox"]
    ]
  ]
);

courier.send(SendMessageRequest.builder()
  .message(Message.of(TemplateMessage.builder()
    .to(MessageRecipient.of(Recipient.of(UserRecipient.builder()
      .userId("example_user")
      .build())))
    .template("TEMPLATE_ID")
    .data(Map.of("name", "Nomen Nescio"))
    .routing(Routing.builder()
      .method("single")
      .channels(List.of("inbox"))
      .build())
    .build()))
  .build());

requestID, err := client.SendMessage(
  context.Background(),
  courier.SendMessageRequestBody{
    Message: map[string]interface{}{
      "to": map[string]string{
        "user_id": "example_user",
      },
      "template": "TEMPLATE_ID",
      "data": map[string]string{
        "name": "Nomen Nescio",
      },
      "routing": map[string]interface{}{
        "method": "single",
        "channels": []string{"inbox"},
      },
    },
  },
)

if err != nil {
  log.Fatal(err)
}
log.Printf("Message sent! Request ID: %s", requestID)

try 
{
  var response = await courier.SendAsync(
    new SendMessageRequest 
    {
      Message = new Message 
      {
        To = new Recipient 
        {
          UserId = "example_user"
        },
        Template = "TEMPLATE_ID",
        Data = new Dictionary<string, object> 
        {
          { "name", "Nomen Nescio" }
        },
        Routing = new MessageRouting 
        {
          Method = "single",
          Channels = new[] { "inbox" }
        }
      }
    });

  Console.WriteLine($"Message sent! Request ID: {response.RequestId}");
}
catch (CourierException e)
{
  Console.WriteLine($"Error: {e.Message}");
  Console.WriteLine($"Status Code: {e.StatusCode}");
}

Platform

Developer Tools

Help

Send an Inbox Message

Passing `data` with an Inbox message

Using Courier Elemental Syntax

Send Using A Template

​Passing data with an Inbox message

​Using Courier Elemental Syntax

​Send Using A Template

Passing `data` with an Inbox message

Using Courier Elemental Syntax

Send Using A Template