Campaign Details
communicateUICampaignDetails Based on latest (2026.09)
Create, change, delete and look up Campaign Details, with asset details, asset metrics and audience details. Actions include campaign action and can user manage all HCM campaigns.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE13 actions
- Record key
CampaignId- Required on create
CampaignCodeCampaignNameCampaignStatusCode- At a glance
- 35 fields1 finders42 children1 file/large text fields
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails?fields=ActivatedOnDate,AudEmailLimitEnabledFlag,AudienceCount,AudienceSavedSearchId,CampaignCode&limit=25&onlyData=true
{
"items": [
{
"ActivatedOnDate": "2026-01-31T09:00:00+00:00",
"AudEmailLimitEnabledFlag": true,
"AudienceCount": 0,
"AudienceSavedSearchId": 0,
"CampaignCode": "<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 35
| Attribute | Type | Use |
|---|---|---|
ActivatedOnDate | date-time | Optional on createUpdatableSearchable |
AudEmailLimitEnabledFlag | yes/no · max 1 · default true | Optional on createUpdatableSearchable |
AudienceCount | number | Optional on createUpdatableSearchable |
AudienceSavedSearchId | number | Optional on createUpdatableSearchable |
CampaignCode | text · max 30 | Required on createUpdatableSearchable |
CampaignDescription | text | Optional on createUpdatable |
CampaignDurationCode | text · max 30 | Optional on createUpdatableSearchable |
CampaignId | number | Optional on createSearchable |
CampaignLanguageCode | text · max 30 | Optional on createUpdatableSearchable |
CampaignMediumCode | text · max 32 · default ORA_BASIC | Optional on createUpdatableSearchable |
CampaignName | text · max 240 | Required on createUpdatableSearchable |
CampaignStatusCode | text · max 30 | Required on createUpdatableSearchable |
CampaignStatusMeaning | text · max 255 | Read-onlySearchable |
CampaignTypeCode | text · max 30 | Optional on createUpdatableSearchable |
CancelledOnDate | date-time | Optional on createUpdatableSearchable |
ClosedOnDate | date-time | Optional on createUpdatableSearchable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
EligObjId | number | Optional on createUpdatableSearchable |
EligPrflId | number | Optional on createUpdatableSearchable |
HCMListExtractionDate | date-time | Optional on createUpdatableSearchable |
HCMListId | number | Optional on createUpdatableSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
ObjectVersionNumber | number | Optional on createUpdatableSearchable |
PurposeCode | text · max 30 | Optional on createUpdatableSearchable |
RequisitionSavedSearchId | number | Optional on createUpdatableSearchable |
ResponseOption | text · max 30 | Optional on createUpdatableSearchable |
SearchRequisitionsFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
TargetGoalValue | number | Optional on createUpdatableSearchable |
TeamDownloadAudienceFlag | yes/no · max 255 | Read-onlySearchable |
TeamId | number | Optional on createUpdatableSearchable |
TeamName | text · max 255 | Read-onlySearchable |
VanityConfigId | number | 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.
Finders 1
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
RowFinder
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 42
Child resources sit under one record: /hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/<name>. Add them to a GET with expand.
assetDetailsGET · POST · PATCH · DELETE Campaign Channel Details · 33 fields · 3 findersAssetFrequencyAssetIdAssetNameAssetStatusCodeAssetStatusMeaningAssetTypeCodeCampaignIdContentLastModifiedCreatedByCreatedByDisplayNameCreationDateDescriptionDesignMetadataFollowupDelayFrequencyHTMLTemplateLastDeliveryDateLastUpdateDateLastUpdateLoginLastUpdatedByMSTeamsTextMessageDesignIdObjectVersionNumberParentAssetIdPublishDestCodePublishDestMeaningSMSTextScheduledDateSelectedTemplateIdSendImmediatelyFlagSenderProfileConfigIdSiteNumberStartDeliveryDateassetContentsGET Campaign Asset Contents · 11 fieldsAssetContentIdAssetIdBodyCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberSubjectTemplateIdassetMetricsGET · POST · PATCH · DELETE Campaign Channel Metrics · 3 fieldsAssetIdPrimaryClickedCountSecondaryClickedCountaudienceSegmentsGET · POST · PATCH · DELETE Campaign Audience Segments · 11 fieldsAssetIdAssetSegmentIdCreatedByCreationDateCriteriaTypeCodeGoalResponseIdLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberSegmentTypeCodeexternalChannelsGET · POST · PATCH · DELETE Campaign External Channels · 10 fieldsAssetIdCampAssetExternalChannelIdCampExternalChannelIdCampExternalWorkspaceIdCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumbernotificationMetricsGET · POST · PATCH · DELETE Grow Notification Metrics · 10 fieldsAssetFrequencyAssetIdClicksLastDeliveryDateNextCycleDateNotificationIdNotificationsSentOpenedStartDeliveryDateTotalCyclespostContentGET · POST · PATCH · DELETE Campaign Banner Details · 21 fieldsAssetIdCreatedByCreationDateDescriptionImageURLLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberPostContentIdPrimaryAssetURLPrimaryAssetURLIdPrimaryDeepLinkIdPrimaryLabelPrimaryLinkTypeCodeSecondaryAssetURLSecondaryAssetURLIdSecondaryDeepLinkIdSecondaryLabelSecondaryLinkTypeCodeTitleassetMetricsGET Campaign Asset Metrics · 19 fieldsAssetIdAssetNameAssetStatusCodeAssetTypeCodeCampaignIdClickCountDeliveredCountLastDeliveryDateNoMobileNumberCountOpenCountParentAssetIdScheduledDateSentCountStartDeliveryDateSubjectCodeTotalCountUndeliveredCountUnsentCountUnsubscribedCountaudienceDetailsGET · POST · PATCH · DELETE Campaign Audience Details · 23 fieldsAddedAudienceCountAudExcludedFlagAudienceCountAudienceCriteriaAudienceExtractionDateAudienceExtractionStatusAudienceIdAudienceSourceIdAudienceSourceNameAudienceSourceTypeCampaignIdColumnMappingCreatedByCreationDateCustomTokensDescriptionExcludedAudienceCountLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberRefreshFlagStatusCampaignAudienceSourceItemsGET · POST · PATCH · DELETE Campaign Target Audience Details · 4 fieldsAudienceIdAudienceItemIdItemIdItemMeaningattachmentsGET · POST · PATCH · DELETE Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNamemetricsGET Campaign Audience Details Metrics · 12 fields · 1 findersAudienceCountAudienceIdCreatedByCreationDateEntityIdEntityNameLastUpdateDateLastUpdateLoginLastUpdatedByMetricIdMetricTypeObjectVersionNumberboAssociationGET · POST · PATCH · DELETE Campaign Business Object Association · 12 fieldsBoAssignedAfterDateBoGoalBoTypeCampBoIdCampaignIdCreatedByCreationDateExcludeBoAudFlagLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberboAssocItemsGET · POST · PATCH · DELETE Campaign Business Object Association Items · 9 fieldsBoIdCampBoIdCampBoItemIdCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumbercampaignBoMetricsGET Campaign Business Object Association Metrics · 11 fieldsCampBoItemIdCountCreatedByCreationDateDisplayContextLastUpdateDateLastUpdateLoginLastUpdatedByMetricIdObjectVersionNumberStatuscampaignPropertiesGET · POST · PATCH · DELETE Campaign Properties · 3 fields · 1 findersCampPropertyIdPropertyCodePropertyValuecategoriesGET · POST · DELETE Campaign Categories · 3 fieldsCampCategoryIdCampaignIdCategoryCodeexternalAssetMetricesGET External Asset Metrics · 11 fields · 1 findersAssetIdAssetNameAssetStatusCodeAssetTypeCodeCampaignIdNoExternalUsrParentAssetIdRecipientCountScheduledDateSentCountUnsentCountexternalWorkspacesGET · POST · PATCH · DELETE Campaign External Workspaces · 12 fields · 1 findersCampExternalWorkspaceIdCampTeamExternalMsgSenderIdCampaignIdCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberTeamIdTeamNameTeamSourcechannelsGET · POST · PATCH · DELETE Campaign External Channels · 10 fieldsCampExternalChannelIdCampExternalWorkspaceIdChannelIdChannelNameCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumbergoalsGET · POST · PATCH · DELETE Campaigns Goals · 12 fieldsCampaignIdCreatedByCreationDateGoalIdGoalNameGoalTypeCodeLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberPrimaryGoalFlagSystemGoalFlagresponseChoicesGET · POST · PATCH · DELETE Campaign Goal Response Choices · 12 fieldsCreatedByCreationDateDestinationURLGoalIdGoalResponseIdIncludeInTargetFlagLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberResponseLabelUseDefaultURLFlagresponseMetricsGET Campaign Goal Response Metrics · 4 fieldsGoalIdGoalResponseIdResponseCountResponseLabelmsTeamsMessageMetricsGET Metrics for Microsoft Teams Messages Associated with a Campaign · 4 fieldsAssetIdAssetNameAssetStatusCodeScheduleDatechannelMessagesGET Metrics for Messages Sent Through Microsoft Teams Channels · 9 fieldsAiDiscussionSummaryAssetIdCampChannelMessageIdChannelNameMessageIdPostAsTeamNameTotalReactionTotalRepliesownersGET · POST · PATCH · DELETE Campaign Owners · 13 fieldsAssignmentIdCollaboratorRespTypeCodeCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByMemberTypeCodeObjectIdObjectTypeObjectVersionNumberPersonIdTeamMemberIdquestionnaireDetailsGET · POST · PATCH · DELETE Questionnaire Details · 13 fieldsAnonymousFlagCampQstnrDetailsIdCampaignIdCreatedByCreationDateLastResponseDateLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberQstnrVersionNumberQuestionnaireIdQuestionnaireTitlequestionnairesGET Questionnaires · 8 fieldsInUseLatestVersionMaximumPossibleScoreNameQuestionnaireCodeQuestionnaireIdQuestionnaireVersionNumberScoreQuestionnairesectionsGET · POST · PATCH Sections · 4 fieldsMandatoryNameQuestionnaireSectionIdSectionSequenceNumberquestionsGET · POST · PATCH · DELETE Questions · 26 fieldsAllowAttachmentsFlagCategoryIdClassificationTypeMeaningConditionQuestionIdConditionQuestionVersionNumberInstructionsTextLatestVersionMandatoryMandatoryMeaningMaximumPossibleScoreMaximumThresholdScoreMinimumThresholdScoreOwnerPrivacyFlagQuestionCodeQuestionIdQuestionTextQuestionTypeQuestionTypeMeaningQuestionVersionNumberQuestionnaireQuestionIdResponseTypeIdScoreQuestionSequenceNumberStatusSubscriberIdanswersGET · POST · PATCH · DELETE Answers · 4 fieldsAnswerCodeLongTextQuestionAnswerIdSequenceNumberquestionDetailsGET · POST · PATCH · DELETE Questions · 14 fieldsAllowAttachmentsFlagCategoryIdInstructionsTextLatestVersionOwnerPrivacyFlagQuestionCodeQuestionIdQuestionTextQuestionTypeQuestionVersionNumberResponseTypeIdStatusSubscriberIdquestionsGET Campaign Question Labels in the Questionnaire Details · 10 fieldsQstnVersionNumberQstnrQuestionIdQstnrVersionNumberQuestionIdQuestionTextQuestionTypeQuestionnaireIdResponseCountSequenceNumberTypeanswersGET Responses from Respondents for the Campaign Questions · 6 fieldsLongTextQstnAnswerIdQstnVersionNumberQuestionIdResponseCountSequenceNumberquestionnaireMetricsGET Campaign Questionnaire Metrics · 4 fieldsCampaignIdDeliveredCountRespondedCountSentCountrequisitionMetricsGET Campaign Job Requisition Metrics · 3 fieldsCampaignIdGoalTypeCodeMetricCountrequisitionsGET · POST · PATCH · DELETE Campaign Requisitions · 9 fieldsCampaignIdCampaignRequisitionIdCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberRequisitionIdselectedLanguagesGET · POST · PATCH · DELETE Campaign Languages · 11 fieldsCampLanguageIdCampaignIdCreatedByCreationDateIsBaseFlagLanguageCodeLanguageDescriptionLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberslackMessageMetricsGET Slack Messages Metrics · 4 fieldsAssetIdAssetNameAssetStatusCodeScheduleDatechannelMessagesGET Slack Channel Messages · 10 fieldsAiDiscussionSummaryAssetIdCampChannelMessageIdChannelNameMessageIdMessageURLPostAsTeamNameTotalReactionTotalRepliesunifiedWorkspaceChannelsGET Unified Workspace Channels · 6 fields · 1 findersCampExternalChannelIdCampExternalWorkspaceIdCampaignIdChannelNameTeamNameTeamSourceuploadAudiencesGET Campaign Audience Upload Records · 15 fieldsAudienceIdAudienceUploadIdCampaignIdCreatedByCreationDateDataJsonEmailErrorCodeLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberPersonIdPhoneStatus
Actions 13
POST …/action/campaignAction·actionTypecampaignIdassetIdcampaignNamePOST …/action/canUserManageAllHCMCampaignsPOST …/{CampaignId}/child/assetDetails/action/assetAction·actionTypeassetIdPOST …/{CampaignId}/child/assetDetails/action/createOrEditSurvey·reminderSubjectassetSegmentssendImmediatelyFlagfinalSubjectcampaignIdfollowupDelayreminderBodylastDeliveryDatestartDeliveryDateselectedTemplateIdassetIdassetNameinitialSubjectfinalBodyinitialBodyPOST …/{CampaignId}/child/audienceDetails/action/filePreview·asyncIdattachIdPOST …/{CampaignId}/child/audienceDetails/action/fileValidationStatus·audienceIdPOST …/{CampaignId}/child/audienceDetails/action/getAudienceUploadListFileSizePOST …/{CampaignId}/child/audienceDetails/action/processFile·audienceIdPOST …/{CampaignId}/child/audienceDetails/action/resetMappings·requestMapaudienceIdPOST …/{CampaignId}/child/msTeamsMessageMetrics/action/regenrateAiSummary·CampaignIdAssetIdChannelMsgIdPOST …/{CampaignId}/child/questionnaireDetails/{CampQstnrDetailsId}/child/questionnaires/{questionnairesUniqID}/action/getMetadataPOST …/{CampaignId}/child/slackMessageMetrics/action/regenrateAiSummary·CampaignIdAssetIdChannelMsgIdPOST …/{CampaignId}/child/uploadAudiences/action/findByAdvancedSearchQuery·offsetquerylimitsearchFieldsfilterssortdisplayFieldsautocompleteQuery
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
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetailsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
RowFinderfor 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:ActivatedOnDate, notactivatedondate. - 8 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.