Conversations
conversations Based on latest (2026.09)
Create, change, delete and look up Conversations, with conversation references.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE
- Record key
ConversationNumber- Required on create
- none marked
- At a glance
- 20 fields2 finders1 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/conversations?fields=BUOrgId,ConversationAlternateId,ConversationId,ConversationNumber,ConversationSortDate&limit=25&onlyData=true
{
"items": [
{
"BUOrgId": 0,
"ConversationAlternateId": "<string, max 255>",
"ConversationId": 0,
"ConversationNumber": "<string, max 30>",
"ConversationSortDate": "2026-01-31T09:00:00+00:00"
}
],
"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 20
| Attribute | Type | Use |
|---|---|---|
BUOrgId | number | Optional on createUpdatableSearchable |
ConversationAlternateId | text · max 255 | Optional on createUpdatableSearchable |
ConversationId | number | Read-onlySearchable |
ConversationNumber | text · max 30 | Optional on createSearchable |
ConversationSortDate | date-time | Read-onlySearchable |
ConversationStatusCd | text · max 30 | Optional on createUpdatableSearchable |
ConversationStatusCdMeaning | text · max 255 | Read-onlySearchable |
ConversationTypeCd | text · max 30 | Optional on createSearchable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
OriginalSystemReference | text · max 1000 | Optional on createUpdatableSearchable |
OriginatedConversationId | number | Optional on createUpdatableSearchable |
OriginatedConversationNumber | text · max 30 | Optional on createSearchable |
PrimaryMessageId | number | Optional on createSearchable |
PrimaryMessageNumber | text · max 30 | Optional on createSearchable |
PrimaryMessageTitle | text · max 1000 | Read-onlySearchable |
StripeCd | text · max 30 | Optional on createSearchable |
Names, types, labels and flags from Oracle's REST specification (latest (2026.09)). Flexfield and custom attributes vary by pod: check /describe for yours.
Finders 2
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
ConversationByNumber·ConversationNumberConversationsByPerson·SenderOrRecipientPartyId
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/conversations/{ConversationNumber}/child/<name>. Add them to a GET with expand.
conversationReferencesGET · POST · PATCH · DELETE Conversation References · 13 fieldsConversationIdConversationNumberCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByObjectIdObjectNumberObjectTypeCdObjectTypeCdMeaningReferenceIdReferenceNumber
Use in AI Agent Studio
- Point a Business Object or REST tool at
/crmRestApi/resources/11.13.18.05/conversationsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
ConversationByNumberfor the agent's main search: its variables become clean tool parameters. - 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:BUOrgId, notbuorgid. - 9 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.