Campaign Respondents
communicateUICampaignRespondents Based on latest (2026.09)
Create, change, delete and look up Campaign Respondents. Actions include download response summary and find by advanced search query.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE3 actions
- Record key
PersonId- Required on create
- none marked
- At a glance
- 13 fields0 finders0 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/communicateUICampaignRespondents?fields=AssignmentType,BusinessId,BusinessUnit,CampaignCode,CampaignId&limit=25&onlyData=true
{
"items": [
{
"AssignmentType": "<string, max 30>",
"BusinessId": 0,
"BusinessUnit": "<string, max 240>",
"CampaignCode": "<string, max 30>",
"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 13
| Attribute | Type | Use |
|---|---|---|
AssignmentType | text · max 30 | Read-onlySearchable |
BusinessId | number | Read-onlySearchable |
BusinessUnit | text · max 240 | Read-onlySearchable |
CampaignCode | text · max 30 | Read-onlySearchable |
CampaignId | number | Read-onlySearchable |
EmailAddress | text · max 255 | Read-onlySearchable |
EmployeeName | text · max 240 | Read-onlySearchable |
LastRespondDate | date-time | Read-onlySearchable |
LocationId | number | Read-onlySearchable |
PersonId | number | Read-onlySearchable |
QuestionsAndResponses | text · max 255 | Read-onlySearchable |
RESPONDED | text · max 1 | Read-onlySearchable |
WorkLocation | text · max 240 | Read-onlySearchable |
Names, types, labels and flags from Oracle's REST specification (latest (2026.09)). Flexfield and custom attributes vary by pod: check /describe for yours.
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Actions 3
POST …/action/downloadResponseSummary·offsetquerylimitfilterssortdisplayFieldscampaignCodePOST …/action/findByAdvancedSearchQuery·offsetquerylimitfilterssortdisplayFieldscampaignCodePOST …/action/getCampaignAudienceResponses·offsetquerylimitfilterssortdisplayFieldscampaignCode
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/communicateUICampaignRespondentsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - 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:AssignmentType, notassignmenttype. - 13 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.