Campaigns
campaigns Based on latest (2026.09)
Create, change, delete and look up Campaigns, with campaign account attribution criteria, campaign accounts and campaign products.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE12 actions
- Record key
CampaignNumber- Required on create
CampaignName- At a glance
- 47 fields1 finders11 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/campaigns?fields=ActualCost,BudgetedCost,CampaignCategory,CampaignCreatedBy,CampaignCreationDate&limit=25&onlyData=true
{
"items": [
{
"ActualCost": 0,
"BudgetedCost": 0,
"CampaignCategory": "ORA_MARKETING",
"CampaignCreatedBy": "<string, max 64>",
"CampaignCreationDate": "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 47
| Attribute | Type | Use |
|---|---|---|
ActualCost | number | Optional on createUpdatableSearchable |
BudgetedCost | number | Optional on createUpdatableSearchable |
CampaignCategory | text · max 30 · default ORA_MARKETING | Optional on createUpdatableSearchable |
CampaignCreatedBy | text · max 64 | Optional on createSearchable |
CampaignCreationDate | date-time | Optional on createSearchable |
CampaignId | number | Optional on createSearchable |
CampaignLastUpdateDate | date-time | Optional on createUpdatableSearchable |
CampaignLastUpdatedBy | text · max 64 | Optional on createUpdatableSearchable |
CampaignName | text · max 100 | Required on createUpdatableSearchable |
CampaignNumber | text · max 30 | Optional on createSearchable |
CampaignOrigin | text · max 30 · default MKT_CAMPAIGN | Optional on createSearchable |
CampaignType | text · max 30 | Optional on createUpdatableSearchable |
CampaignTypeMeaning | text · max 80 | Read-onlySearchable |
CreatedBy | text · max 64 | Read-only |
CreatedByModule | text · max 60 · default ORA_WS | Optional on createSearchable |
CreationDate | date-time | Read-onlySearchable |
CurrencyCode | text · max 15 | Optional on createUpdatableSearchable |
DeleteFlag | yes/no | Read-only |
Description | text · max 2000 | Optional on createUpdatable |
EndDate | date-time | Optional on createUpdatableSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-only |
LastUpdatedBy | text · max 64 | Read-only |
NumberOfAssociatedAccounts | number | Optional on createUpdatable |
NumberOfLeadsErrored | number | Optional on createUpdatable |
NumberOfLeadsGenerated | number | Optional on createUpdatable |
OwnerId | number | Optional on createUpdatableSearchable |
OwnerPartyName | text · max 360 | Optional on createUpdatable |
OwnerPartyNumber | text · max 30 | Read-onlySearchable |
ParentCampaignId | number | Optional on createUpdatableSearchable |
ParentCampaignName | text · max 100 | Read-onlySearchable |
ParentCampaignNumber | text · max 30 | Read-onlySearchable |
ProductDescription | text · max 100 | Optional on createUpdatableSearchable |
RegionCode | text · max 100 | Optional on createUpdatableSearchable |
SalesTargetCampaignDaysToVerify | number | Optional on createUpdatable |
SalesTargetCampaignEloquaSyncDate | date-time | Optional on createUpdatable |
SalesTargetCampaignStage | text · max 32 | Optional on createUpdatableSearchable |
SalesTargetLeadsCreationDate | date-time | Optional on createUpdatable |
SourceSystemCampaignId | text · max 100 | Optional on createUpdatableSearchable |
SourceSystemEmailId | number | Optional on createUpdatable |
SourceSystemLandingPageId | number | Optional on createUpdatable |
SourceSystemSegmentId | number | Optional on createUpdatable |
SourceSystemSharedListId | number | Optional on createUpdatable |
StartDate | date-time | Optional on createUpdatableSearchable |
Status | text · max 30 · default ORA_DRAFT | Optional on createUpdatableSearchable |
StatusLookupMeaning | text · max 80 | 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 1
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
CampaignNumberAltKey·CampaignNumber
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 11
Child resources sit under one record: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/<name>. Add them to a GET with expand.
CampaignAccountAttributionCriteriaGET · POST · PATCH · DELETE Campaign Account Attribution Criteria · 14 fields · 1 findersCampaignAccountAttrCriteriaIdCampaignAccountAttrCriteriaNumberCampaignCampaignNumberCampaignIdCreatedByCreationDateCriteriaExpressionCriteriaTypeExclusionCriteriaFlagLastUpdateDateLastUpdateLoginLastUpdatedBySourceObjectAttrSourceObjectCodeCampaignAccountsGET · POST · PATCH · DELETE Campaign Accounts · 20 fields · 2 findersAccountCountryAccountIdAccountIndustryClassCodeAccountNameAccountPartyNumberAccountStateAccountTotalEmployeesCampaignAccountIdCampaignAccountNumberCampaignIdCampaignNumberCreatedByCreationDateErrorDescriptionLastUpdateDateLastUpdatedByLeadIdLeadNameLeadNumberQueryCriteriaTypeCampaignProductsGET · POST · PATCH · DELETE Campaign Products · 16 fields · 3 findersCampaignIdCampaignNumberCampaignProductIdCampaignProductNumberCreatedByCreationDateInventoryItemIdInventoryOrgIdItemNameItemNumberLastUpdateDateLastUpdatedByProductGroupIdProductGroupNameProductGroupNumberProductTypeCampaignRollupGET Campaign Rollups · 30 fieldsCampaignIdCorpCurrencyCodeCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByNumberOfContactsNumberOfConvertedLeadsNumberOfEmailActivitiesNumberOfEmailClickThroughActivitiesNumberOfEmailOpenActivitiesNumberOfEmailSendActivitiesNumberOfEngagedContactsNumberOfFormSubmitActivitiesNumberOfLeadsNumberOfLostOpportunitiesNumberOfNoSaleOpportunitiesNumberOfOpenHotLeadsNumberOfOpenLeadsNumberOfOpenOpportunitiesNumberOfOpportunitiesNumberOfRetiredLeadsNumberOfWebVisitActivitiesNumberOfWonOpportunitiesSumOfAllOpportunitiesRevenueSumOfConvertedOpportunitiesRevenueSumOfOpenLeadAmountSumOfOpenOpportunitiesRevenueSumOfWonOpportunitiesRevenueCampaignTeamGET · POST · PATCH · DELETE Campaign Teams · 18 fields · 2 findersAccessLevelCodeApproverFlagCampaignIdCampaignNumberCampaignTeamIdCampaignTeamNumberCreatedByCreationDateEmailAddressFormattedPhoneNumberLastUpdateDateLastUpdatedByMemberFunctionCodeOwnerFlagResourceIdResourceNameResourcePartyNumberRoleNameMktCampaignMembersGET Campaign Members · 34 fields · 3 findersActiveCampaignCampaignNameCampaignCampaignNumberCampaignEndDateCampaignIdCampaignMemberIdCampaignMemberNumberCampaignStartDateCampaignStatusCampaignTypeContactEmailContactIdContactPartyNameContactPartyNumberCreatedByCreatedByModuleCreationDateCurrencyCodeDeleteFlagEmailAddressLastUpdateDateLastUpdateLoginLastUpdatedByLeadAccountNameLeadEmailLeadIdLeadLeadNameLeadLeadNumberLeadOwnerNameMemberResponseDateMemberStatusMemberStatusLookupMeaningSourceSystemCampMemberIdUpdateFlagSalesContentsGET · POST · PATCH · DELETE Sales Contents · 16 fieldsCanDeleteCanUpdateContentItemIdContentItemNameContentItemTypeContentSourceSystemDeletedInSourceFlagDisplaySequenceParentObjectIdParentObjectTypePublicContentItemIdPublicContentItemNamePublicCustomerNamePublicPublishedDatePublicStoryLinkSalesContentIdsmartActionsGET Smart Actions · 17 fieldsActionIntentConfirmationMessageContentTypeDisplayLabelEntityHrefIncludedInApplicationMassActionFlagMethodObjectFunctionNamePageTypeSmartSuggestFlagSystemActionFlagUpdateOfAttributesUserActionIdUserActionNameUserActionRankUserActionNavigationGET Smart Action User Interface Definitions · 5 fieldsSystemActionFlagUserActionNavAppUsageUserActionNavBodyUserActionNavIdUserActionNavTypeUserActionRequestPayloadGET Smart Action REST Payload Definitions · 8 fieldsBindingMandatoryFlagRequestPayloadIdRequestPayloadNameSmartSuggestPathSystemActionFlagValueValueStructUserActionURLBindingGET Smart Action REST Path Parameter Definitions · 5 fieldsBindingSystemActionFlagURLBindingIdURLBindingNameValue
Actions 12
POST …/{CampaignNumber}/child/SalesContents/action/deleteContentAssociation·contentItemIdPOST …/{CampaignNumber}/child/SalesContents/action/markContentAssociationForDeletion·contentItemIdPOST …/{CampaignNumber}/child/SalesContents/action/renameContent·contentItemIdcontentNamePOST …/{CampaignNumber}/child/smartActions/action/executeActionForRows·payloadPOST …/{CampaignNumber}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{CampaignNumber}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{CampaignNumber}/child/smartActions/action/getActionsForRows·payloadPOST …/{CampaignNumber}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{CampaignNumber}/child/smartActions/action/getEntitiesPOST …/{CampaignNumber}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{CampaignNumber}/child/smartActions/action/processMassAction·payloadPOST …/{CampaignNumber}/child/smartActions/{campaigns_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/campaignsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
CampaignNumberAltKeyfor 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:ActualCost, notactualcost. - 12 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.