Recruiting Campaign Email Designs
recruitingMessageDesigns Based on latest (2026.09)
Create, change, delete and look up Recruiting Campaign Email Designs, with message design metadata and message design types. Actions include create template and duplicate template.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE4 actions
- Record key
MessageDesignId- Required on create
DesignNameDesignTypeCodeMessageDesignCode- At a glance
- 13 fields3 finders3 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns?fields=CreatedByName,DesignEditorTypeCode,DesignEditorTypeCodeMeaning,DesignName,DesignStatusCode&limit=25&onlyData=true
{
"items": [
{
"CreatedByName": "<string, max 255>",
"DesignEditorTypeCode": "ORA_ADVANCED",
"DesignEditorTypeCodeMeaning": "<string, max 255>",
"DesignName": "<string, max 240>",
"DesignStatusCode": "<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 13
| Attribute | Type | Use |
|---|---|---|
CreatedByName | text · max 255 | Read-onlySearchable |
DesignEditorTypeCode | text · max 30 · default ORA_ADVANCED | Optional on createUpdatableSearchable |
DesignEditorTypeCodeMeaning | text · max 255 | Optional on createUpdatableSearchable |
DesignName | text · max 240 | Required on createUpdatableSearchable |
DesignStatusCode | text · max 30 | Optional on createUpdatableSearchable |
DesignStatusCodeMeaning | text · max 255 | Optional on createUpdatableSearchable |
DesignTypeCode | text · max 30 | Required on createUpdatableSearchable |
DesignTypeCodeMeaning | text · max 255 | Optional on createUpdatableSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
MessageDesignCode | text · max 32 | Required on createUpdatableSearchable |
MessageDesignId | number | Optional on createSearchable |
ModuleId | text · max 32 | Optional on createUpdatableSearchable |
TemplateDescription | text · max 240 | 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 3
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
FindByMessageDesignCode·MessageDesignCodeRowFinder·pCampaignIdpDesignEditorTypeCodepDesignStatusCodepDesignTypeCodepLookupCodefindByMessageDesignIds·MessageDesignId
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 3
Child resources sit under one record: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/<name>. Add them to a GET with expand.
attachmentsGET · POST · PATCH · DELETE Communicate Attachments · 34 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDocumentPreviewURLDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleTrackerIdUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNamemessageDesignMetadataGET · POST · PATCH · DELETE Message Design Metadata · 11 fieldsDefaultLanguageFlagDescriptionDescriptionStringDesignMetaDataStringDesignMetadataHTMLTemplateHTMLTemplateStringImageURLMessageDesignIdMessageLanguageSubjectmessageDesignTypesGET · POST · PATCH · DELETE Message DesignTypes · 2 fieldsMeaningTypeCode
Actions 4
POST …/action/createTemplate·templateTypetypestemplateDesignCodetemplateNamedesignEditorTypeCodetemplateDescriptioncopyFromTemplateIdPOST …/action/duplicateTemplate·templateNameemailTypetemplateDescriptionsourceMessageDesignIdPOST …/action/findByAdvancedSearchQuery·offsetquerylimitsearchFieldsfilterssortdisplayFieldsautocompleteQueryPOST …/action/updateTemplateStatus·messageDesignIdstatus
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/recruitingMessageDesignsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
FindByMessageDesignCodefor 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:DesignEditorTypeCode, notdesigneditortypecode. - 2 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.