Outbound Messages
outboundMessages Based on latest (2026.09)
Create, change, delete and look up Outbound Messages, with outbound msg parts. Actions include get message details and get outbound msg attachments.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE4 actions
- Record key
OutboundMessageId- Required on create
SourceCdStatusCd- At a glance
- 40 fields0 finders1 children2 file/large text fields
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/outboundMessages?fields=AlternateMessageId,BUOrgId,Body,ChannelId,ChannelTypeCd&limit=25&onlyData=true
{
"items": [
{
"AlternateMessageId": "<string, max 2000>",
"BUOrgId": 0,
"Body": "<string>",
"ChannelId": 0,
"ChannelTypeCd": "<string, max 30>"
}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0
}Shapes and placeholders, not real data. Replace https://<your-pod> and the login with your own: this site never sees them. Based on Oracle's latest (2026.09) REST specification.
Fields 40
| Attribute | Type | Use |
|---|---|---|
AlternateMessageId | text · max 2000 | Optional on createUpdatableSearchable |
BUOrgId | number | Optional on createUpdatableSearchable |
Body | text | Optional on createUpdatable |
ChannelId | number | Optional on createUpdatableSearchable |
ChannelTypeCd | text · max 30 | Optional on createUpdatableSearchable |
CorpCurrencyCode | text · max 15 | Optional on createUpdatableSearchable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
CurcyConvRateType | text · max 30 | Optional on createUpdatableSearchable |
CurrencyCode | text · max 15 | Optional on createUpdatableSearchable |
DeleteFlag | yes/no | Read-only |
DeliveryServiceCd | text · max 30 · default ORA_SVC_UMS | Optional on createUpdatableSearchable |
DeliveryTypeCd | text · max 30 · default ORA_SVC_IMMEDIATE | Optional on createUpdatableSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-only |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
MessageContent | text | Optional on createUpdatable |
OutboundMessageId | number | Optional on createUpdatableSearchable |
OutboundMessageNumber | text · max 30 | Optional on createSearchable |
PostedByPartyid | number | Optional on createUpdatableSearchable |
ProcessingStatusCd | text · max 30 | Optional on createUpdatableSearchable |
ReplyToAddress | text · max 240 | Optional on createUpdatableSearchable |
RetryCount | number · default 0 | Optional on createUpdatableSearchable |
SenderEmailSourceCd | text · max 30 | Optional on createUpdatableSearchable |
SenderName | text · max 100 | Optional on createUpdatableSearchable |
SentDate | date-time | Optional on createUpdatableSearchable |
SourceCd | text · max 30 | Required on createUpdatableSearchable |
SourceMsgObjId | number | Optional on createUpdatableSearchable |
SourceMsgObjTypeCd | text · max 30 | Optional on createUpdatableSearchable |
SourceObjId | number | Optional on createUpdatableSearchable |
SourceObjPkName | text · max 30 | Optional on createUpdatableSearchable |
SourceObjTemplateName | text · max 240 | Optional on createUpdatableSearchable |
SourceObjTypeCd | text · max 30 | Optional on createUpdatableSearchable |
StatusCd | text · max 30 | Required on createUpdatableSearchable |
StatusDetails | text · max 1000 | Optional on createUpdatableSearchable |
StripeCd | text · max 30 | Optional on createUpdatableSearchable |
Subject | text · max 400 | Optional on createUpdatableSearchable |
UpdateFlag | yes/no | Optional on createUpdatable |
UsePostedByEmailFlag | yes/no · max 1 · default false | Optional on createUpdatableSearchable |
UsePostedByNameFlag | yes/no · max 1 · default false | Optional on createUpdatableSearchable |
Names, types, labels and flags from Oracle's REST specification (latest (2026.09)). Flexfield and custom attributes vary by pod: check /describe for yours.
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 1
Child resources sit under one record: /crmRestApi/resources/11.13.18.05/outboundMessages/{OutboundMessageId}/child/<name>. Add them to a GET with expand.
OutboundMsgPartsGET · POST · PATCH · DELETE Outbound Message Parts · 15 fieldsCorpCurrencyCodeCreatedByCreationDateCurcyConvRateTypeCurrencyCodeDeleteFlagLastUpdateDateLastUpdateLoginLastUpdatedByOutboundMessageIdOutboundMsgPartIdPartNamePartTypeCdPartValueUpdateFlag
Actions 4
POST …/action/getMessageDetails·previewmessageTypetemplateNamesubjectmessageIdsourceCdobjectIdchannelIdobjectTypePOST …/action/getOutboundMsgAttachments·isTemplateAttachmentRequiredoutboundMsgIdPOST …/action/getOutboundMsgDetails·outboundMsgIdisMimeMessagePOST …/action/updateOutboundMsgProcessingStatus·objectTypeCodealternateMsgIdoutboundMsgIdprocessingStatusCdretryCountstatusDetails
Actions use Content-Type: application/vnd.oracle.adf.action+json. A path with a {key} runs on one record.
Use in AI Agent Studio
- Point a Business Object or REST tool at
/crmRestApi/resources/11.13.18.05/outboundMessagesand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Narrow with
q=on searchable fields and a smalllimit; for a count usetotalResults=true&limit=1. - Call once and pass the result on to later steps rather than calling the same endpoint again.
- This resource can change data. Put a human approval step before any create, update, delete or action call.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:AlternateMessageId, notalternatemessageid. - 6 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
- Send dates as
YYYY-MM-DD; date-time fields take ISO 8601 with a time zone. - A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.