Interactions
interactions Based on latest (2026.09)
Create, change, delete and look up Interactions, with interaction data, interaction participants and child interactions.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE9 actions
- Record key
InteractionId- Required on create
ChannelId- At a glance
- 49 fields6 finders8 children1 file/large text fields
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/interactions?fields=APPClassificationCd,APPInterfaceTypeCd,AccountPartyId,AccountPartyNumber,AccountPartyUniqueName&limit=25&onlyData=true
{
"items": [
{
"APPClassificationCd": "<string, max 30>",
"APPInterfaceTypeCd": "<string, max 30>",
"AccountPartyId": 0,
"AccountPartyNumber": "<string, max 30>",
"AccountPartyUniqueName": "<string, max 900>"
}
],
"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 49
| Attribute | Type | Use |
|---|---|---|
APPClassificationCd | text · max 30 | Optional on createUpdatableSearchable |
APPInterfaceTypeCd | text · max 30 | Optional on createUpdatableSearchable |
AccountPartyId | number | Optional on createUpdatableSearchable |
AccountPartyNumber | text · max 30 | Read-onlySearchable |
AccountPartyUniqueName | text · max 900 | Read-onlySearchable |
AgentHTTPSessionId | text · max 100 | Optional on createUpdatableSearchable |
ChannelDisplayName | text · max 400 | Read-onlySearchable |
ChannelId | number | Required on createUpdatableSearchable |
ChannelShortName | text · max 450 | Read-onlySearchable |
ChannelTypeCd | text · max 30 | Optional on createUpdatableSearchable |
ContactPartyId | number | Optional on createUpdatableSearchable |
ContactPartyNumber | text · max 30 | Read-onlySearchable |
ContactPartyUniqueName | text · max 900 | Read-onlySearchable |
ContactPersonId | number | Optional on createUpdatableSearchable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
DeleteFlag | yes/no | Read-only |
Description | text · max 1000 | Optional on createUpdatableSearchable |
DirectionCd | text · max 30 · default ORA_SVC_INBOUND | Optional on createUpdatableSearchable |
EndInteractionFlag | yes/no | Optional on createUpdatable |
EndTime | date-time | Optional on createUpdatableSearchable |
InteractionId | number | Read-onlySearchable |
InteractionNumber | text · max 30 | Optional on createSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
ManuallyLoggedFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
MarketingReferenceId | number | Optional on createUpdatableSearchable |
MediaItemId | text · max 255 | Optional on createUpdatableSearchable |
OriginalSystemReference | text · max 255 | Optional on createUpdatableSearchable |
OwnerResourceId | number | Optional on createUpdatableSearchable |
OwnerResourcePartyNumber | text · max 30 | Read-onlySearchable |
OwnerResourcePartyUniqueName | text · max 900 | Read-onlySearchable |
ParentInteractionId | number | Optional on createUpdatableSearchable |
ParentInteractionNumber | text · max 30 | Read-onlySearchable |
PartnerAccountPartyId | number | Optional on createUpdatableSearchable |
Payload | text | Optional on createUpdatable |
QueueId | number | Optional on createUpdatableSearchable |
QueueName | text · max 400 | Read-onlySearchable |
QueueNumber | text · max 30 | Optional on createSearchable |
SourceCd | text · max 30 | Optional on createUpdatableSearchable |
SourceCdMeaning | text · max 255 | Read-onlySearchable |
StartInteractionFlag | yes/no · default true | Optional on createUpdatable |
StartTime | date-time | Optional on createUpdatableSearchable |
StatusCd | text · max 30 · default ORA_SVC_OPEN | Optional on createUpdatableSearchable |
StripeCd | text · max 30 | Optional on createSearchable |
SubstatusCd | text · max 30 | Optional on createUpdatableSearchable |
TopLevelFlag | yes/no | Read-onlySearchable |
UpdateFlag | yes/no | Read-only |
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 6
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
InteractionRowFinderById·BindInteractionIdBindStripeCdInteractionRowFinderByMediaItemId·BindMediaItemIdInteractionRowFinderByObject·ObjectIdObjectTypeCdInteractionRowFinderByOwnerCustomerTimeInteractionRowFinderByOwnerCustomerTimeObjectOpenChildInteractionRowFinderByChannelCustomerOwner·BindAccountPartyIdBindChannelIdBindContactPartyIdBindOwnerResourceIdBindParentInteractionId
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 8
Child resources sit under one record: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/<name>. Add them to a GET with expand.
InteractionDataGET · POST · PATCH · DELETE Interaction Data · 12 fields · 1 findersCreatedByCreationDateDeletedFlagInteractionDataIdInteractionDataNumberInteractionIdInteractionNumberLastUpdateDateLastUpdateLoginLastUpdatedByTokenIdValueInteractionParticipantsGET · POST · PATCH · DELETE Interaction Participants · 25 fields · 1 findersContactPartyIdContactPartyNumberContactPartyUniqueNameCreatedByCreationDateDurationMinutesEmailEndTimeInteractionIdInteractionNumberInteractionParticipantIdInteractionParticipantNumberJsonLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberOriginalSystemReferenceParticipantNameParticipantTypeCdPhoneResourcePartyIdResourcePartyNumberResourcePartyUniqueNameStartTimechildInteractionsGET · POST · PATCH · DELETE Child Interactions · 49 fields · 6 findersAPPClassificationCdAPPInterfaceTypeCdAccountPartyIdAccountPartyNumberAccountPartyUniqueNameAgentHTTPSessionIdChannelDisplayNameChannelIdChannelShortNameChannelTypeCdContactPartyIdContactPartyNumberContactPartyUniqueNameContactPersonIdCreatedByCreationDateDeleteFlagDescriptionDirectionCdEndInteractionFlagEndTimeInteractionIdInteractionNumberLastUpdateDateLastUpdateLoginLastUpdatedByManuallyLoggedFlagMarketingReferenceIdMediaItemIdOriginalSystemReferenceOwnerResourceIdOwnerResourcePartyNumberOwnerResourcePartyUniqueNameParentInteractionIdParentInteractionNumberPartnerAccountPartyIdPayloadQueueIdQueueNameQueueNumberSourceCdSourceCdMeaningStartInteractionFlagStartTimeStatusCdStripeCdSubstatusCdTopLevelFlagUpdateFlaginteractionReferencesGET · POST · PATCH · DELETE Interaction References · 13 fields · 1 findersCreatedByCreationDateDeleteFlagInteractionIdInteractionNumberLastUpdateDateLastUpdateLoginLastUpdatedByObjectIdObjectNumberObjectTypeCdReferenceIdUpdateFlagsmartActionsGET Smart Actions · 17 fields · 5 findersActionIntentConfirmationMessageContentTypeDisplayLabelEntityHrefIncludedInApplicationMassActionFlagMethodObjectFunctionNamePageTypeSmartSuggestFlagSystemActionFlagUpdateOfAttributesUserActionIdUserActionNameUserActionRankUserActionNavigationGET Smart Action User Interface Definitions · 5 fields · 1 findersSystemActionFlagUserActionNavAppUsageUserActionNavBodyUserActionNavIdUserActionNavTypeUserActionRequestPayloadGET Smart Action REST Payload Definitions · 8 fields · 1 findersBindingMandatoryFlagRequestPayloadIdRequestPayloadNameSmartSuggestPathSystemActionFlagValueValueStructUserActionURLBindingGET Smart Action User Interface Definitions · 5 fields · 1 findersBindingSystemActionFlagURLBindingIdURLBindingNameValue
Actions 9
POST …/{InteractionId}/child/smartActions/action/executeActionForRows·payloadPOST …/{InteractionId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{InteractionId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{InteractionId}/child/smartActions/action/getActionsForRows·payloadPOST …/{InteractionId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{InteractionId}/child/smartActions/action/getEntitiesPOST …/{InteractionId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{InteractionId}/child/smartActions/action/processMassAction·payloadPOST …/{InteractionId}/child/smartActions/{interactions_smartActions_Id}/action/executeAction
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/interactionsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
InteractionRowFinderByIdfor 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:APPClassificationCd, notappclassificationcd. - 20 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.