Postman collection

Test the Courier API in Postman with no integration code. The collection is updated with every release, so it always reflects the latest endpoints.

Open the Courier collection in Postman

Fork it into your workspace, then add your API key and send.

Set up

Fork the collection

Open the collection above and click Fork. Your copy stays linked to the source, so you can pull in updates. Requires a Postman account.

Add bearer auth

On the forked collection’s Authorization tab, set Auth Type to Bearer Token and enter {{auth_token}}.

Create an environment

In Environments, add Courier Test with a variable auth_token. Paste your into Current value (not Initial value, which syncs to Postman’s cloud). Repeat for Production, then pick an environment.

Send your first request

With Courier Test active, open Send a Message (), add a body, and click Send. template is the ID or alias of a published . data supplies its variables:

const { requestId } = await courier.send.message({
  message: {
    to: {
      user_id: "user_123",
    },
    template: "nt_01kx4h2jdafq8bk9aftxak4b40",
    data: {
      name: "Sarah Bennett",
    },
    routing: {
      method: "single",
      channels: [
        "email",
      ],
    },
  },
});

response = client.send.message(
    message={
        "to": {
            "user_id": "user_123",
        },
        "template": "nt_01kx4h2jdafq8bk9aftxak4b40",
        "data": {
            "name": "Sarah Bennett",
        },
        "routing": {
            "method": "single",
            "channels": [
                "email",
            ],
        },
    },
)

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",
      "data": {
        "name": "Sarah Bennett"
      },
      "routing": {
        "method": "single",
        "channels": [
          "email"
        ]
      }
    }
  }'

response = courier.send_.message(
  message: {
    to: {
      user_id: "user_123"
    },
    template: "nt_01kx4h2jdafq8bk9aftxak4b40",
    data: {
      name: "Sarah Bennett"
    },
    routing: {
      method: "single",
      channels: [
        "email"
      ]
    }
  }
)

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"),
		Data: map[string]any{
			"name": "Sarah Bennett",
		},
		Routing: courier.SendMessageParamsMessageRouting{
			Channels: []shared.MessageRoutingChannelUnionParam{
				{OfString: courier.String("email")},
			},
			Method: "single",
		},
	},
})

SendMessageParams params = SendMessageParams.builder()
    .message(SendMessageParams.Message.builder()
        .to(UserRecipient.builder().userId("user_123").build())
        .template("nt_01kx4h2jdafq8bk9aftxak4b40")
        .data(JsonValue.from(java.util.Map.of(
            "name", "Sarah Bennett"
        )))
        .routing(SendMessageParams.Message.Routing.builder()
            .addChannel("email")
            .method(SendMessageParams.Message.Routing.Method.SINGLE)
            .build())
        .build())
    .build();
SendMessageResponse response = client.send().message(params);

$response = $client->send->message(
  message: [
    'to' => [
      'user_id' => 'user_123',
    ],
    'template' => 'nt_01kx4h2jdafq8bk9aftxak4b40',
    'data' => [
      'name' => 'Sarah Bennett',
    ],
    'routing' => [
      'method' => 'single',
      'channels' => [
        'email',
      ],
    ],
  ],
);

SendMessageParams parameters = new()
{
    Message = new()
    {
        To = new UserRecipient { UserID = "user_123" },
        Template = "nt_01kx4h2jdafq8bk9aftxak4b40",
        Data = new Dictionary<string, JsonElement>()
        {
            { "name", JsonSerializer.SerializeToElement("Sarah Bennett") },
        },
        Routing = new() { Channels = ["email"], Method = Send::Method.Single },
    },
};

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

courier send message \
  --api-key "$COURIER_API_KEY" \
  --message.to '{"user_id": "user_123"}' \
  --message.template nt_01kx4h2jdafq8bk9aftxak4b40 \
  --message.data '{"name": "Sarah Bennett"}' \
  --message.routing '{"method": "single", "channels": ["email"]}'

With Courier MCP, send my nt_01kx4h2jdafq8bk9aftxak4b40 template to user_123.

Courier returns a requestId you can track in your .

Treat your API key like a password. Use Postman Vault for team keys, and if it leaks.

Get started

Send messages

Journeys

Broadcasts

Design

Recipients

Tenants

Monitoring

Workspaces

Resources

Postman collection

Open the Courier collection in Postman

Set up

Send your first request

Open the Courier collection in Postman

​Set up

​Send your first request

Set up

Send your first request