This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
Send messages in Global Inbox.
Validation failure for any message will cause the entire request to throw before any messages are sent.
The response reports all messages which were successfully sent, and any messages which failed to be sent due to a conflict with an existing message.
Callers must be added to the internal "External Inbox Alert Producers" group in Gotham Security (multipass).
Note that the recipient realm must be specified if the caller's realm is not identical. For
example, to send to the "Everyone" group in the "palantir-internal-realm" realm, the caller must either specify the realm or already be
in "palantir-internal-realm".
booleanRepresents a boolean value that restricts an endpoint to preview mode when set to true.
objectlist<SendMessageRequest>objectlist<GroupRecipient>The groups of users to send this message to.
objectstringThe name for the group in Gotham Security (multipass).
stringThe name for the realm for this group. If no realm is specified, the caller's realm is used instead.
objectStatic text details to display for the message sender. Content is secured using the message-level security.
stringobjectA static text title for the message. Content is secured using the message-level security.
stringobjectA static text body for the message. Content is secured using the message-level security.
stringstring (enum)The formatting style to apply to text when rendering:
UNFORMATTED: Should be rendered as a simple string, no extra formatting is applied.PREFORMATTED: Whitespace is maintained and the content is rendered in a monospace font.MARKDOWN: Markdown rendering should be applied.Enum values: UNFORMATTED, PREFORMATTED, MARKDOWN
objectlist<PortionMarking>Collection of classification portion markings; markings are validated against the system's Classification Based Access Control (CBAC) rules; if invalid, an error is raised.
stringSecurity markings represent the level of access control that applies to a specific piece of information (e.g., object property, object title). Security markings are required upon creating a new object, and upon adding a new property to an existing object. To access information with one or more markings, the user must have access to the markings associated with that information as defined by your organization's defined security rules. Only users with the correct permissions can get, update, or delete a property with security markings.
In particular, if a user creates an object and adds a property of type with highly restricted markings, it is possible that subsequent calls to the get object properties endpoint may fail to display the highly restricted property.
Contact your Palantir administrator for more information on the markings that your organization uses.
objectSuccess response
list<SendMessageResponse>The list of messages which were sent successfully. Messages are returned in the order in which they were sent in the request.
objectstringThe unique identifier assigned to the Global Inbox message.
list<SendMessageFailure>The list of messages which failed to be sent in Inbox due to conflicts with existing messages.
objectstringThe unique identifier assigned to the Global Inbox message.
string (enum)The reason for a failure to send an Inbox message:
CONFLICTING_SOURCE_ID: A message with the same MessageSourceId already exists.UNKNOWN: The message failed to send due to an unknown conflict.Enum values: CONFLICTING_SOURCE_ID, UNKNOWN
1
2
3
4
5
curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/gotham/v1/inbox/messages?preview=true" \
-d '{"messages":[{"sender":{"displayName":"My External Message Sender"},"title":{"value":"Hello from the sendMessages API!"},"security":{"portionMarkings":["SENSITIVE"]},"groupRecipients":[{"name":"my-example-group"}],"body":{"value":"Some **styled** extra content for my message","formatStyle":"MARKDOWN"}}]}'1
2
3
4
5
6
7
{
"responses": [
{
"sourceId": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
}
]
}