Campaign Members
campaignMembers Based on latest (2026.09)
Create, change, delete and look up Campaign Members, with smart actions.
The record key campaignMembersUniqID is a generated hash. Take it from the record's links (rel self) in a GET response; never build it yourself.
Oracle documents an Effective-Of header and an effectiveDate parameter for this resource, used for date-effective reads and changes.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE9 actions
- Record key
campaignMembersUniqID- Required on create
CampaignIdMemberResponseDate- At a glance
- 34 fields3 finders4 children
- Extra parameters
?effectiveDate=Effective-Of:
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/campaignMembers?fields=Active,CampaignCampaignName,CampaignCampaignNumber,CampaignEndDate,CampaignId&limit=25&onlyData=true
{
"items": [
{
"Active": "Y",
"CampaignCampaignName": "<string, max 100>",
"CampaignCampaignNumber": "<string, max 30>",
"CampaignEndDate": "2026-01-31T09:00:00+00:00",
"CampaignId": 0
}
],
"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 34
| Attribute | Type | Use |
|---|---|---|
Active | text · max 1 · default Y | Optional on createUpdatableSearchable |
CampaignCampaignName | text · max 100 | Read-onlySearchable |
CampaignCampaignNumber | text · max 30 | Optional on createSearchable |
CampaignEndDate | date-time | Read-onlySearchable |
CampaignId | number | Required on createUpdatableSearchable |
CampaignMemberId | number | Optional on createSearchable |
CampaignMemberNumber | text · max 30 | Optional on createSearchable |
CampaignStartDate | date-time | Read-onlySearchable |
CampaignStatus | text · max 30 · default ORA_DRAFT | Read-onlySearchable |
CampaignType | text · max 30 | Read-onlySearchable |
ContactEmail | text · max 320 | Read-onlySearchable |
ContactId | number | Optional on createUpdatableSearchable |
ContactPartyName | text · max 360 | Read-onlySearchable |
ContactPartyNumber | text · max 30 | Optional on createUpdatableSearchable |
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 createUpdatable |
DeleteFlag | yes/no | Read-only |
EmailAddress | text · max 320 | Optional on createUpdatableSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-only |
LastUpdatedBy | text · max 64 | Read-only |
LeadAccountName | text · max 360 | Read-onlySearchable |
LeadEmail | text · max 320 | Read-onlySearchable |
LeadId | number | Optional on createUpdatableSearchable |
LeadLeadName | text · max 250 | Read-onlySearchable |
LeadLeadNumber | text · max 30 | Optional on createUpdatableSearchable |
LeadOwnerName | text · max 360 | Read-onlySearchable |
MemberResponseDate | date-time | Required on createUpdatableSearchable |
MemberStatus | text · max 30 · default ORA_SENT | Optional on createUpdatableSearchable |
MemberStatusLookupMeaning | text · max 80 | Read-onlySearchable |
SourceSystemCampMemberId | text · max 100 | Optional on createUpdatableSearchable |
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 3
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
CampaignMemberNumAltKey·CampaignMemberNumberCampaignMemberUniqueContactsFinder·CampaignIdCampaignMemberUniqueLeadsFinder·CampaignId
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 4
Child resources sit under one record: /crmRestApi/resources/11.13.18.05/campaignMembers/{campaignMembersUniqID}/child/<name>. Add them to a GET with expand.
smartActionsGET 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 …/{campaignMembersUniqID}/child/smartActions/action/executeActionForRows·payloadPOST …/{campaignMembersUniqID}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{campaignMembersUniqID}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{campaignMembersUniqID}/child/smartActions/action/getActionsForRows·payloadPOST …/{campaignMembersUniqID}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{campaignMembersUniqID}/child/smartActions/action/getEntitiesPOST …/{campaignMembersUniqID}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{campaignMembersUniqID}/child/smartActions/action/processMassAction·payloadPOST …/{campaignMembersUniqID}/child/smartActions/{campaignMembers_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/campaignMembersand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
CampaignMemberNumAltKeyfor 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:Active, notactive. - 19 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
onlyData=trueremoveslinks, and this resource's key only comes fromlinks. Leave it off when you need the key.- 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.