---
title: "POST /v2/console/satori/direct-message"
method: POST
path: "/v2/console/satori/direct-message"
tags: ["Console"]
---

# POST /v2/console/satori/direct-message

`POST /v2/console/satori/direct-message`

## Request

- Base URL: `http://127.0.0.1:7351`
- URL: `http://127.0.0.1:7351/v2/console/satori/direct-message`
- Auth: API key in header `Authorization`

## Request body

- SendDirectMessageRequest: The request to send direct messages.
  - `template_id` string: The identifier of the template used to render the message content.
  - `identity_ids` string[]: A list of recipient identity IDs.
  - `integrations` MessageIntegrationType[]: A list of integrations to use for sending the message.
  - `persist` boolean: Whether the message should be stored in the recipient's inbox.
  - `channels` object: If applicable, channels to send this message through, per integration.
  - `template_override` TemplateOverride: An template override.
    - `title` string: The title to generate the message's title.
    - `value` string: The template value to generate the message's content.
    - `image_url` string: The image_url for the message.
    - `json_metadata` string
    - `variants` object: Language-specific template overrides. The key is the language code.

## Response `200`

A successful response.

- SendDirectMessageResponse: The response for the SendDirectMessageRequest.
  - `delivery_results` DeliveryResult[]: Results for each attempted message delivery.
    - `recipient_id` string: The identity ID of the recipient.
    - `integration_results` IntegrationResult[]: Results for each valid integration used in the delivery.
      - `integration_type` 'UNKNOWN_MESSAGE_TYPE' | 'FCM' | 'APNS' | 'FACEBOOK_NOTIFICATION' | 'ONESIGNAL_NOTIFICATION' | 'WEBHOOK_NOTIFICATION': Message integration's names. - FCM: The variant for Google's Firebase Cloud Messaging. - APNS: The variant for Apple's Message system. - FACEBOOK_NOTIFICATION: The variant for Facebook App-to-User Notifications. - ONESIGNAL_NOTIFICATION: The variant for OneSignal Notifications. - WEBHOOK_NOTIFICATION: The variant for Webhook Notifications.
      - `success` boolean: Whether the message was successfully delivered using this integration.
      - `error_message` string: An error message, if the delivery failed.
      - `channel_type` 'DEFAULT' | 'PUSH' | 'EMAIL': Message channel types. - PUSH: Push notification. - EMAIL: Email.

## Other responses

- `default`: An unexpected error response.

---

[API](https://skmtc.dev/heroiclabs/apis/nakama-console-api-v2.md) - [All operations](https://skmtc.dev/heroiclabs/apis/nakama-console-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/heroiclabs/apis/nakama-console-api-v2/revisions/fbde2e3c5ead?raw)