Sales Leads
leads Based on latest (2026.09)
Create, change, delete and look up Sales Leads, with assessments, interviews and lead campaigns. Actions include accept lead and convert lead and get opty.
The record key leadsUniqID 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)DELETE96 actions
- Record key
leadsUniqID- Required on create
Name- At a glance
- 169 fields3 finders59 children
- Extra parameters
?effectiveDate=Effective-Of:
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/leads?fields=AILeadScore,AcceptedDate,AcceptedDateTime,AccountPartyNumber,AddrElementAttribute1&limit=25&onlyData=true
{
"items": [
{
"AILeadScore": 0,
"AcceptedDate": "2026-01-31",
"AcceptedDateTime": "2026-01-31T09:00:00+00:00",
"AccountPartyNumber": "<string, max 30>",
"AddrElementAttribute1": "<string, max 150>"
}
],
"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 169
| Attribute | Type | Use |
|---|---|---|
AILeadScore | number | Read-onlySearchable |
AcceptedDate | date | Read-only |
AcceptedDateTime | date-time | Read-onlySearchable |
AccountPartyNumber | text · max 30 | Read-onlySearchable |
AddrElementAttribute1 | text · max 150 | Optional on createUpdatable |
AddrElementAttribute2 | text · max 150 | Optional on createUpdatable |
AddrElementAttribute3 | text · max 150 | Optional on createUpdatable |
AddrElementAttribute4 | text · max 150 | Optional on createUpdatable |
AddrElementAttribute5 | text · max 150 | Optional on createUpdatable |
AddressLinesPhonetic | text · max 560 | Optional on createUpdatable |
ApprovalDate | date | Optional on createUpdatable |
ApprovalDateTime | date-time | Optional on createUpdatable |
AssetId | number | Optional on createUpdatableSearchable |
AssetNumber | text · max 100 | Optional on createUpdatableSearchable |
AssetSerialNumber | text · max 100 | Read-onlySearchable |
AssignmentStatusCode | text · max 30 | Optional on createUpdatableSearchable |
BudgetAmount | number | Optional on createUpdatable |
BudgetCurrencyCode | text · max 80 | Optional on createUpdatable |
BudgetStatus | text · max 120 | Optional on createUpdatableSearchable |
Building | text · max 40 | Optional on createUpdatable |
BusinessUnitId | number | Optional on create |
CampaignName | text · max 250 | Read-onlySearchable |
ChannelType | text · max 30 | Optional on createUpdatableSearchable |
ClassCode1 | text · max 30 | Optional on createUpdatable |
ClassCode2 | text · max 30 | Optional on createUpdatable |
ClassCode3 | text · max 30 | Optional on createUpdatable |
ClassCode4 | text · max 30 | Optional on createUpdatable |
ConflictId | number · default 1 | Optional on createUpdatableSearchable |
ContactDoNotPreference | yes/no · max 30 | Optional on createUpdatable |
ContactFormattedAddress | text | Read-only |
ContactPartyNumber | text · max 30 | Read-onlySearchable |
ContactTimezoneCd | text · max 35 | Optional on createUpdatableSearchable |
ConvertedDateTime | date-time | Optional on createUpdatable |
CreatedBy | text · max 64 | Read-only |
CreationDate | date-time | Read-onlySearchable |
CurrencyCode | text · max 15 | Optional on createUpdatable |
CustPartyType | text · max 30 | Optional on createUpdatable |
CustomerId | number | Optional on createUpdatableSearchable |
CustomerNeed | text · max 30 | Optional on createUpdatable |
CustomerPartyName | text · max 360 | Optional on createUpdatableSearchable |
DealAmount | number | Optional on createUpdatableSearchable |
DecisionMakerIdentifiedFlag | yes/no · max 120 · default false | Optional on createUpdatable |
DeleteFlag | yes/no | Read-only |
Description | text · max 2000 | Optional on createUpdatable |
Distance | number | Read-only |
EligibleForConversionFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
EnableCreateAccount | text · max 1 | Optional on createUpdatable |
EnableCreateContact | text · max 1 | Optional on createUpdatable |
EstimatedCloseDate | date | Optional on createUpdatable |
ExpirationDate | date | Optional on createUpdatable |
FloorNumber | text · max 40 | Optional on createUpdatable |
FollowupTimestamp | date | Optional on createUpdatable |
FormattedPhoneNumber1 | text | Read-only |
IBAssetId | number | Optional on createUpdatableSearchable |
IBAssetNumber | text · max 80 | Read-onlySearchable |
IBAssetSerialNumber | text · max 80 | Read-onlySearchable |
InventoryItemDescription | text · max 240 | Optional on createUpdatable |
JobTitle | text · max 100 | Optional on createUpdatableSearchable |
LastAssignmentDate | date-time | Optional on createUpdatableSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-only |
LastUpdatedBy | text · max 64 | Read-only |
Latitude | number | Optional on createUpdatableSearchable |
LeadAcceptedFlag | yes/no · max 4 | Optional on createUpdatableSearchable |
LeadAging | number | Read-onlySearchable |
LeadCreatedBy | text · max 64 | Optional on createSearchable |
LeadCreationDate | date-time | Optional on createSearchable |
LeadId | number | Optional on createUpdatableSearchable |
LeadLastUpdateDate | date-time | Optional on createUpdatableSearchable |
LeadLastUpdatedBy | text · max 64 | Optional on createUpdatableSearchable |
LeadNumber | text · max 30 | Optional on createSearchable |
LeadOrigin | text · max 30 · default SALES_LEAD | Optional on createSearchable |
Longitude | number | Optional on createUpdatableSearchable |
Name | text · max 250 | Required on createUpdatableSearchable |
OpportunityIdForConvert | number | Optional on createUpdatable |
OpportunityName | text | Optional on createUpdatable |
OpportunityOwnerNumber | text | Optional on createUpdatable |
OrganizationName | text · max 360 | Read-only |
OrganizationSize | text · max 30 | Optional on createUpdatable |
OrganizationType | text · max 30 | Optional on createUpdatable |
OwnerId | number | Optional on createUpdatableSearchable |
OwnerPartyName | text · max 360 | Optional on createUpdatableSearchable |
OwnerPartyNumber | text · max 30 | Read-onlySearchable |
PartnerCompanyNumber | text · max 30 | Optional on createSearchable |
PartnerId | number | Optional on createUpdatableSearchable |
PartnerPartyName | text | Optional on createUpdatableSearchable |
PartnerProgramId | number | Optional on createUpdatable |
PartnerProgramNumber | text · max 30 | Optional on createSearchable |
PartnerType | text · max 30 | Optional on createUpdatable |
PostalPlus4Code | text · max 10 | Optional on createUpdatable |
PrimaryCampaignId | number | Optional on createUpdatableSearchable |
PrimaryCampaignName | text | Optional on createUpdatableSearchable |
PrimaryCampaignNumber | text · max 30 | Optional on createUpdatableSearchable |
PrimaryCompetitorName | text | Optional on createUpdatableSearchable |
PrimaryCompetitorPartyId | number | Optional on createUpdatableSearchable |
PrimaryCompetitorPartyNumber | text · max 30 | Read-onlySearchable |
PrimaryContactAddress1 | text · max 240 | Optional on createUpdatableSearchable |
PrimaryContactAddress2 | text · max 240 | Optional on createUpdatableSearchable |
PrimaryContactAddress3 | text · max 240 | Optional on createUpdatable |
PrimaryContactAddress4 | text · max 240 | Optional on createUpdatable |
PrimaryContactCity | text · max 60 | Optional on createUpdatableSearchable |
PrimaryContactCountry | text · max 2 | Optional on createUpdatableSearchable |
PrimaryContactCountryName | text | Read-only |
PrimaryContactCounty | text · max 60 | Optional on createUpdatableSearchable |
PrimaryContactEmailAddress | text · max 320 | Optional on createUpdatableSearchable |
PrimaryContactEmailPreference | text · max 30 | Optional on createUpdatable |
PrimaryContactEmailVerificationDate | date-time | Optional on createUpdatable |
PrimaryContactEmailVerificationStatus | text · max 30 | Optional on createUpdatable |
PrimaryContactId | number | Optional on createUpdatableSearchable |
PrimaryContactMailPreference | text · max 30 | Optional on createUpdatable |
PrimaryContactNumber | text · max 64 | Optional on createUpdatableSearchable |
PrimaryContactPartyName | text · max 450 | Optional on createUpdatableSearchable |
PrimaryContactPersonFirstName | text · max 150 | Optional on createUpdatableSearchable |
PrimaryContactPersonLastName | text · max 150 | Optional on createUpdatableSearchable |
PrimaryContactPersonMiddleName | text · max 150 | Optional on createUpdatableSearchable |
PrimaryContactPhonePreference | text · max 30 | Optional on createUpdatable |
PrimaryContactPostalCode | text · max 60 | Optional on createUpdatableSearchable |
PrimaryContactProvince | text · max 60 | Optional on createUpdatable |
PrimaryContactRelationshipId | number | Optional on createUpdatable |
PrimaryContactState | text · max 60 | Optional on createUpdatableSearchable |
PrimaryInventoryItemId | number | Optional on createUpdatable |
PrimaryInventoryItemNumber | text · max 300 | Read-onlySearchable |
PrimaryInventoryOrgId | number | Optional on createUpdatable |
PrimaryPhoneAreaCode | text · max 10 | Optional on createUpdatable |
PrimaryPhoneCountryCode | text · max 10 | Optional on createUpdatable |
PrimaryPhoneNumber | text · max 40 | Optional on createUpdatableSearchable |
PrimaryPhoneVerificationDate | date-time | Optional on createUpdatable |
PrimaryPhoneVerificationStatus | text · max 30 | Optional on createUpdatable |
PrimaryProductGroupId | number | Optional on createUpdatable |
PrimaryProductGroupReferenceNumber | text · max 820 | Read-onlySearchable |
ProductGroupDescription | text · max 1000 | Read-only |
ProductGroupName | text · max 250 | Optional on createUpdatableSearchable |
ProductType | text | Optional on createUpdatable |
ProgramName | text | Optional on createUpdatable |
Project | text · max 30 | Optional on createUpdatable |
QualificationScore | number · default 0 | Read-only |
QualifiedDate | date | Optional on createUpdatable |
QualifiedDateTime | date-time | Optional on createUpdatable |
Rank | text · max 30 | Optional on createUpdatableSearchable |
RawPrimaryPhoneNumber | text | Optional on createUpdatableSearchable |
ReassignComment | text · max 1000 | Optional on createUpdatable |
ReassignReasonCode | text · max 30 | Optional on createUpdatableSearchable |
RecordSet | text | Read-onlySearchable |
RegistrationNumber | text · max 120 | Optional on createUpdatableSearchable |
RegistrationStatus | text · max 120 | Optional on createUpdatableSearchable |
RegistrationType | text · max 120 | Optional on createUpdatableSearchable |
RejectByUserId | number | Optional on createUpdatable |
RejectComment | text · max 250 | Optional on createUpdatable |
RejectReasonCode | text · max 30 | Optional on createUpdatableSearchable |
RejectedDateTime | date-time | Optional on createUpdatable |
RetireComment | text · max 250 | Optional on createUpdatable |
RetireReasonCode | text · max 30 | Optional on createUpdatableSearchable |
RetiredDateTime | date-time | Optional on createUpdatable |
SalesChannel | text · max 120 | Optional on createUpdatable |
SalesTargetLeadEloquaSyncDate | date-time | Optional on createUpdatable |
SalesTargetLeadOptOutComment | text · max 1000 | Optional on createUpdatable |
SalesTargetLeadOptOutDate | date-time | Optional on createUpdatable |
SalesTargetLeadOptOutReasonCode | text · max 32 | Optional on createUpdatable |
SalesTargetLeadStage | text · max 32 | Optional on createUpdatableSearchable |
SalesTargetLeadValidationDueDate | date-time | Optional on createUpdatable |
Score | number | Optional on createUpdatableSearchable |
SourceCode | text · max 30 | Optional on createUpdatableSearchable |
StatusCode | text · max 30 · default UNQUALIFIED | Optional on createUpdatableSearchable |
Timeframe | text · max 120 | Optional on createUpdatableSearchable |
ToReassignFlag | yes/no · max 1 · default false | Optional on createUpdatable |
UpdateFlag | yes/no | Read-only |
WorkPhoneAreaCode | text · max 10 | Optional on createUpdatable |
WorkPhoneCountryCode | text · max 10 | Optional on createUpdatable |
WorkPhoneNumber | text · max 40 | 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.
LeadsFinderByContactId·ContactIdMklLeadVOAltKey·LeadNumberMyLeadsFinder·NameResourcePartyIdRestRestCreationDateLowerRestCreationDateUpperRestRecordSetRestStatusCode
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 59
Child resources sit under one record: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/<name>. Add them to a GET with expand.
AllLeadAttachmentsGET · POST · PATCH · DELETE Sales Leads Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNameAssessmentsGET · POST · PATCH · DELETE Lead Qualifications · 20 fieldsAssessTemplateIdAssessedLanguageAssessedObjTypeCodeAssessedObjectIdAssessmentIdAssessmentScoreBusinessUnitConflictIdCreatedByLastUpdateDateLastUpdatedByNameRatingFeedbackRatingTermStatusCodeStatusFuseTemplateNameTemplateTypeTotalAnsweredTotalQuestionsAssessAnswerGroupsGET Assessment Answer Groups · 4 fieldsAssessAnswerGroupIdAssessmentIdAttributeGroupIdNameAssessmentAnswerGET · PATCH Assessment Answers · 10 fieldsAnswerIdAnsweredAssessmentIdAttributeGroupIdAttributeIdAttributeNameAttributeValueIdCommentsHasCommentsResponseValueInterviewsGET · DELETE Interviews · 24 fields · 6 findersAttachmentIdAuthoringInterviewNumberCreatedByCreationDateInterviewDataInterviewDataLangInterviewDraftInterviewIdInterviewNameInterviewNumberInterviewOutcomeInterviewScoreInterviewStatusInterviewTypeLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberOwnerResourceIdOwnerResourceNumberOwnerResourcePartyNameSourceObjectCodeSourceObjectIdSourceObjectNumbersmartActionsGET 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 fieldsBindingSystemActionFlagURLBindingIdURLBindingNameValueLeadCampaignsGET · POST · PATCH · DELETE Lead Campaigns · 16 fields · 2 findersCampaignEndDateCampaignIdCampaignNameCampaignNumberCampaignStartDateCampaignStatusCampaignTypeCreatedByCreationDateLastUpdateDateLastUpdatedByLeadCampaignIdLeadCampaignNumberLeadIdLeadNumberPrimaryFlagsmartActionsGET 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 fieldsBindingSystemActionFlagURLBindingIdURLBindingNameValueLeadCompetitorsGET · POST · PATCH · DELETE Sales Lead Competitors · 15 fields · 1 findersCommentsCompetitorPartyIdCompetitorPartyNameCompetitorPartyNumberCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByLeadCompetitorIdLeadCompetitorNumberLeadIdLeadNumberPrimaryFlagThreatLevelCodesmartActionsGET 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 fieldsBindingSystemActionFlagURLBindingIdURLBindingNameValueLeadOpportunityGET Opportunities · 15 fieldsAccountCurrencyExpectedAmountLeadNameLeadNumberOptyAccountOptyCloseDateOptyIdOptyNameOptyNumberOptyStatusRevenueAmountSalesStageIdSalesStageNameWinProbabilityLeadRollupGET Lead Rollups · 17 fieldsCallsMadeCorpCurrencyCodeCreatedByCreationDateEmailsSentLastCallMadeDateLastCompletedActivityLastEmailSentDateLastTouchDateLastUpdateDateLastUpdateLoginLastUpdatedByLeadIdNextTaskDueNumberOfOpenActivitiesNumberOfTouchesTotalNotesMklLeadResourcesGET · POST · PATCH · DELETE Sales Lead Resources · 22 fields · 2 findersAccessLevelCodeConflictIdCreatedByCreationDateEmailAddressFormattedPhoneNumberFunctionalRoleLastUpdateDateLastUpdateLoginLastUpdatedByLeadIdLeadNumberLeadResourceIdManagerNameNamePartyNamePartyNumberPrimaryFlagPrimaryPhonePurposeResourceIdResourceOrgIdRoleNamesmartActionsGET 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 fieldsBindingSystemActionFlagURLBindingIdURLBindingNameValueMklLeadTcMembers1GET · POST · PATCH · DELETE Sales Lead Contacts · 35 fields · 2 findersAccountNameCityConflictIdContactDoNotCallFlagContactDoNotContactFlagContactDoNotMailFlagContactJobTitleCreatedByCreationDateEmailAddressEmailPreferenceFormattedPhoneNumberJobTitleLastUpdateDateLastUpdateLoginLastUpdatedByLeadIdLeadMemberIdLeadNumberOrgContactIdPartyIdPartyNamePartyNumberPartyTypePartyUsageCodePersonFirstNamePersonLastNamePersonTitlePhonePreferencePostalCodePrimaryCustomerIdPrimaryFlagRelationshipIdRoleStatesmartActionsGET 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 fieldsBindingSystemActionFlagURLBindingIdURLBindingNameValueMklLeadTeamGET Lead Team · 34 fieldsAccessLevelCodeAddedOnDateTimeCityConflictIdCountryCreatedByCreationDateEmailAddressFormattedPhoneNumberFunctionCodeFunctionalRoleLastUpdateDateLastUpdateLoginLastUpdatedByLeadIdLeadNumberLeadResourceIdLeadTeamIdOwnerFlagPartyIdPartyNamePartyNumberPrimaryFlagPrimaryPhoneNumberPrimaryPhonePurposeResourceIdResourceRoleNameStateTerritoryFunctionCodeTerritoryNameTerritoryNumberTerritoryOwnerFlagTerritoryVersionIdTypeCodeMklLeadTerritoryAssocGET Sales Lead Territories · 18 fieldsConflictIdCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByLeadIdLeadTerritoryIdNameOwnerPartyNumberPartnerPartyIdPartnerPartyNamePartyIdPartyNameTerritoryIdTerritoryNumberTerritoryVersionIdTypeCodeMklProdAssoc1GET · POST · PATCH · DELETE Sales Lead Products · 27 fields · 3 findersAmountAverageTimeToCloseConflictIdCreatedByCreationDateCurrencyCodeDescriptionEstimatedUnitPriceInventoryItemIdItemNumberLastUpdateDateLastUpdateLoginLastUpdatedByLeadIdLeadNumberLeadProductIdLeadProductNumberLongDescriptionOrganizationIdPrimaryFlagProductGroupDescriptionProductGroupIdProductGroupNameProductGroupReferenceNumberProductTypeQuantityUOMCodesmartActionsGET 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 fieldsBindingSystemActionFlagURLBindingIdURLBindingNameValueNoteGET · POST · PATCH · DELETE Notes · 27 fieldsContactRelationshipIdCorpCurrencyCodeCreatedByCreationDateCreatorPartyIdCurcyConvRateTypeCurrencyCodeDeleteFlagEmailAddressFormattedAddressFormattedPhoneNumberLastUpdateDateLastUpdateLoginLastUpdatedByNoteIdNoteNumberNoteTitleNoteTxtNoteTypeCodeParentNoteIdPartyIdPartyNameSourceObjectCodeSourceObjectIdSourceSystemUpdateFlagVisibilityCodesmartActionsGET 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 fieldsBindingSystemActionFlagURLBindingIdURLBindingNameValueOrchestrationAssociationsGET · POST · PATCH Orchestration Associations · 21 fields · 1 findersActionParametersAssociationStatusCodeCompletedObjsCntCreatedByCreationDateCurrentAssocFlagLastUpdateDateLastUpdatedByNextStepIdNextStepSmartActionIdOrchestrationAssociationIdOrchestrationAssociationNumberOrchestrationIdOrchestrationNameOrchestrationNumberPendingObjectivesCountPerformActionSkippedNothelpfulObjsCntSourceObjectCodeSourceObjectIdTotalObjsCntErrorLogsGET Error Logs · 20 fields · 1 findersCreatedByCreationDateErrorDescriptionErrorLogsIdErrorLogsNumberErrorTextLastUpdateDateLastUpdatedByOrchestrationAssociationIdOrchestrationIdOrchestrationNameOrchestrationNumberOrchestrationStageIdOrchestrationStageNameOrchestrationStageNumberOrchestrationStepIdOrchestrationStepNameOrchestrationStepNumberSourceObjectCodeSourceObjectIdStageObjectivesGET Stage Objectives · 20 fields · 1 findersCreatedByCreationDateDisplaySequenceLastUpdateDateLastUpdatedByOrchestrationAssociationIdOrchestrationIdOrchestrationNameOrchestrationNumberOrchestrationStageDisplaySequenceOrchestrationStageIdOrchestrationStageNameOrchestrationStageObjDescriptionOrchestrationStageObjDisplaySequenceOrchestrationStageObjNameOrchestrationStageObjNumberOrchestrationStageObjectiveIdRunTimeStageObjectiveIdRunTimeStageObjectiveNumberRunTimeStatusStagesGET Stages · 24 fields · 1 findersCompletedObjsCntCreatedByCreationDateCurrentStageFlagDisplaySequenceLastUpdateDateLastUpdatedByOrchestrationAssociationIdOrchestrationIdOrchestrationNameOrchestrationNumberOrchestrationStageDescriptionOrchestrationStageIdOrchestrationStageNameOrchestrationStageNumberPendingObjectivesCountRunTimeStatusRuntimeStageIdRuntimeStageNumberSkippedNothelpfulObjsCntStageEndDateStageStartDateStepsCountInExecutionPathTotalObjsCntStepTransitionsGET Step Transitions · 59 fields · 1 findersActivityAppointmentStatusCodeActivityDescriptionActivityDueDateActivityEndDateActivityIdActivityNumberActivityOwnerIdActivityOwnerPartyNameActivityPartialDescriptionActivitySMARTActionContextActivitySMARTActionIdActivityStartDateActivitySubjectActivityTaskStatusCodeActivityWebConferenceIdActivityWebConferenceURLAllowSkipFlagCommentsConversationIdCreatedByCreationDateEmailTypeExitOrchestrationFlagIATemplateNameIATemplateValueInboundConvMsgIdInteractionIdLastUpdateDateLastUpdatedByOrchStepTransitionFlagOrchestrationAssociationIdOrchestrationAssociationNumberOrchestrationIdOrchestrationNameOrchestrationNumberOrchestrationStageIdOrchestrationStageNameOrchestrationStageNumberOrchestrationStepIdOrchestrationStepNameOrchestrationStepNumberOrchestrationStepTasksIdOrchestrationStepTypeOutboundConvMsgIdRefreshPageFlagStepDisplaySequenceStepSuggestionTextStepTaskDisplaySequenceStepTemplateIdStepTemplateStepNameStepTransitionIdStepTransitionNumberStepTypeSuccessCriteriaEvalFlagTransitionDueDateTimeTransitionEndDateTimeTransitionStartDateTimeTransitionStatusWrapUpIdStepsGET Steps · 23 fields · 1 findersCreatedByCreationDateCurrentStepFlagDisplaySequenceLastUpdateDateLastUpdatedByOrchestrationAssociationIdOrchestrationIdOrchestrationNameOrchestrationNumberOrchestrationStageIdOrchestrationStageNameOrchestrationStageNumberOrchestrationStepIdOrchestrationStepNameOrchestrationStepNumberRunTimeStatusRunTimeStepIdRunTimeStepNumberStepEndDateStepStartDateStepTemplateIdStepTemplateStepNameStepsInExecutionPathGET Steps In Execution Path · 15 fieldsContainMultipleTasksCurrentStepFlagDisplaySequenceExecutionMethodFulfillsObjectiveCntOrchestrationAssocIdOrchestrationStageIdOrchestrationStageObjIdOrchestrationStepIdOrchestrationStepNameRunTimeStatusStepEndDateStepStartDateStepSuggestionTextStepTypeSalesContentsGET · POST · PATCH · DELETE Sales Contents · 16 fieldsCanDeleteCanUpdateContentItemIdContentItemNameContentItemTypeContentSourceSystemDeletedInSourceFlagDisplaySequenceParentObjectIdParentObjectTypePublicContentItemIdPublicContentItemNamePublicCustomerNamePublicPublishedDatePublicStoryLinkSalesContentIdleadScoreDetailsGET Lead Score Details · 3 fieldsDataTypeFeatureNameFeatureValueproductGroupsGET Product Groups · 8 fieldsDescriptionDisplayNameLastUpdateDateModelConfigAttributesModelNameProdGroupIdQuotableFlagReferenceNumberproductsGET Products · 14 fieldsActiveFlagCSSEnabledDescriptionEndDateInvOrgIdInventoryItemIdLastUpdateDateLongDescriptionProdGroupIdProductNumProductTypeServiceRequestEnabledCodeStartDateTextsmartActionsGET 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 fieldsBindingSystemActionFlagURLBindingIdURLBindingNameValuesourceCodesGET · POST · PATCH · DELETE Marketing Source Codes · 12 fieldsActiveFlagCampaignIdCampaignNameCampaignUsageCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberSourceCodeSourceCodeId
Actions 96
POST …/action/acceptLead·leadIdPOST …/action/convertLeadAndGetOpty·opportunityNameopportunityOwnerNumberattributeMapenableCreateAccountenableCreateContactleadIdPOST …/action/convertLeadToOpty·opportunityNameopportunityOwnerNumberattributeMapenableCreateAccountenableCreateContactleadIdPOST …/action/copyLead·newLeadNameleadIdPOST …/action/createDealRegistration·leadIdPOST …/action/findDuplicates·attributeMapcheckDupContactscheckDupAccountsleadIdPOST …/action/rankLead·leadIdPOST …/action/rejectLead·reasoncommentsleadIdPOST …/action/runAssignment·leadIdPOST …/action/scoreLead·leadIdPOST …/{leadsUniqID}/child/Interviews/action/getInterviewDeployments·querysourceObjectPOST …/{leadsUniqID}/child/Interviews/{InterviewNumber}/child/smartActions/action/executeActionForRows·payloadPOST …/{leadsUniqID}/child/Interviews/{InterviewNumber}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{leadsUniqID}/child/Interviews/{InterviewNumber}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{leadsUniqID}/child/Interviews/{InterviewNumber}/child/smartActions/action/getActionsForRows·payloadPOST …/{leadsUniqID}/child/Interviews/{InterviewNumber}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{leadsUniqID}/child/Interviews/{InterviewNumber}/child/smartActions/action/getEntitiesPOST …/{leadsUniqID}/child/Interviews/{InterviewNumber}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{leadsUniqID}/child/Interviews/{InterviewNumber}/child/smartActions/action/processMassAction·payloadPOST …/{leadsUniqID}/child/Interviews/{InterviewNumber}/child/smartActions/{UserActionId}/action/executeActionPOST …/{leadsUniqID}/child/LeadCampaigns/{LeadCampaignId}/child/smartActions/action/executeActionForRows·payloadPOST …/{leadsUniqID}/child/LeadCampaigns/{LeadCampaignId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{leadsUniqID}/child/LeadCampaigns/{LeadCampaignId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{leadsUniqID}/child/LeadCampaigns/{LeadCampaignId}/child/smartActions/action/getActionsForRows·payloadPOST …/{leadsUniqID}/child/LeadCampaigns/{LeadCampaignId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{leadsUniqID}/child/LeadCampaigns/{LeadCampaignId}/child/smartActions/action/getEntitiesPOST …/{leadsUniqID}/child/LeadCampaigns/{LeadCampaignId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{leadsUniqID}/child/LeadCampaigns/{LeadCampaignId}/child/smartActions/action/processMassAction·payloadPOST …/{leadsUniqID}/child/LeadCampaigns/{LeadCampaignId}/child/smartActions/{UserActionId}/action/executeActionPOST …/{leadsUniqID}/child/LeadCompetitors/{LeadCompetitorId}/child/smartActions/action/executeActionForRows·payloadPOST …/{leadsUniqID}/child/LeadCompetitors/{LeadCompetitorId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{leadsUniqID}/child/LeadCompetitors/{LeadCompetitorId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{leadsUniqID}/child/LeadCompetitors/{LeadCompetitorId}/child/smartActions/action/getActionsForRows·payloadPOST …/{leadsUniqID}/child/LeadCompetitors/{LeadCompetitorId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{leadsUniqID}/child/LeadCompetitors/{LeadCompetitorId}/child/smartActions/action/getEntitiesPOST …/{leadsUniqID}/child/LeadCompetitors/{LeadCompetitorId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{leadsUniqID}/child/LeadCompetitors/{LeadCompetitorId}/child/smartActions/action/processMassAction·payloadPOST …/{leadsUniqID}/child/LeadCompetitors/{LeadCompetitorId}/child/smartActions/{UserActionId}/action/executeActionPOST …/{leadsUniqID}/child/MklLeadResources/{LeadResourceId}/child/smartActions/action/executeActionForRows·payloadPOST …/{leadsUniqID}/child/MklLeadResources/{LeadResourceId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{leadsUniqID}/child/MklLeadResources/{LeadResourceId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{leadsUniqID}/child/MklLeadResources/{LeadResourceId}/child/smartActions/action/getActionsForRows·payloadPOST …/{leadsUniqID}/child/MklLeadResources/{LeadResourceId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{leadsUniqID}/child/MklLeadResources/{LeadResourceId}/child/smartActions/action/getEntitiesPOST …/{leadsUniqID}/child/MklLeadResources/{LeadResourceId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{leadsUniqID}/child/MklLeadResources/{LeadResourceId}/child/smartActions/action/processMassAction·payloadPOST …/{leadsUniqID}/child/MklLeadResources/{LeadResourceId}/child/smartActions/{UserActionId}/action/executeActionPOST …/{leadsUniqID}/child/MklLeadTcMembers1/{LeadMemberId}/child/smartActions/action/executeActionForRows·payloadPOST …/{leadsUniqID}/child/MklLeadTcMembers1/{LeadMemberId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{leadsUniqID}/child/MklLeadTcMembers1/{LeadMemberId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{leadsUniqID}/child/MklLeadTcMembers1/{LeadMemberId}/child/smartActions/action/getActionsForRows·payloadPOST …/{leadsUniqID}/child/MklLeadTcMembers1/{LeadMemberId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{leadsUniqID}/child/MklLeadTcMembers1/{LeadMemberId}/child/smartActions/action/getEntitiesPOST …/{leadsUniqID}/child/MklLeadTcMembers1/{LeadMemberId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{leadsUniqID}/child/MklLeadTcMembers1/{LeadMemberId}/child/smartActions/action/processMassAction·payloadPOST …/{leadsUniqID}/child/MklLeadTcMembers1/{LeadMemberId}/child/smartActions/{UserActionId}/action/executeActionPOST …/{leadsUniqID}/child/MklProdAssoc1/{LeadProductId}/child/smartActions/action/executeActionForRows·payloadPOST …/{leadsUniqID}/child/MklProdAssoc1/{LeadProductId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{leadsUniqID}/child/MklProdAssoc1/{LeadProductId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{leadsUniqID}/child/MklProdAssoc1/{LeadProductId}/child/smartActions/action/getActionsForRows·payloadPOST …/{leadsUniqID}/child/MklProdAssoc1/{LeadProductId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{leadsUniqID}/child/MklProdAssoc1/{LeadProductId}/child/smartActions/action/getEntitiesPOST …/{leadsUniqID}/child/MklProdAssoc1/{LeadProductId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{leadsUniqID}/child/MklProdAssoc1/{LeadProductId}/child/smartActions/action/processMassAction·payloadPOST …/{leadsUniqID}/child/MklProdAssoc1/{LeadProductId}/child/smartActions/{UserActionId}/action/executeActionPOST …/{leadsUniqID}/child/Note/{NoteId}/child/smartActions/action/executeActionForRows·payloadPOST …/{leadsUniqID}/child/Note/{NoteId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{leadsUniqID}/child/Note/{NoteId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{leadsUniqID}/child/Note/{NoteId}/child/smartActions/action/getActionsForRows·payloadPOST …/{leadsUniqID}/child/Note/{NoteId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{leadsUniqID}/child/Note/{NoteId}/child/smartActions/action/getEntitiesPOST …/{leadsUniqID}/child/Note/{NoteId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{leadsUniqID}/child/Note/{NoteId}/child/smartActions/action/processMassAction·payloadPOST …/{leadsUniqID}/child/Note/{NoteId}/child/smartActions/{UserActionId}/action/executeActionPOST …/{leadsUniqID}/child/OrchestrationAssociations/action/detachAssociatedOrchestration·sourceObjectCodesourceObjectIdPOST …/{leadsUniqID}/child/OrchestrationAssociations/action/getNotHelpfulObjectiveDetails·orchAssociationIdorchStageObjIdPOST …/{leadsUniqID}/child/SalesContents/action/deleteContentAssociation·contentItemIdPOST …/{leadsUniqID}/child/SalesContents/action/markContentAssociationForDeletion·contentItemIdPOST …/{leadsUniqID}/child/SalesContents/action/renameContent·contentItemIdcontentNamePOST …/{leadsUniqID}/child/productGroups/action/setUsagCode·usageCodePOST …/{leadsUniqID}/child/productGroups/action/setUsageCode·usageCodePOST …/{leadsUniqID}/child/productGroups/action/setUsageMode·usageModePOST …/{leadsUniqID}/child/productGroups/action/setUserSelectionForTM·valuePOST …/{leadsUniqID}/child/products/action/setSelectedProductGroupId·prodGroupIdPOST …/{leadsUniqID}/child/products/action/setUsageCode·usageCodePOST …/{leadsUniqID}/child/products/action/setUsageMode·usageModePOST …/{leadsUniqID}/child/products/action/setUserSelectionForTM·valuePOST …/{leadsUniqID}/child/smartActions/action/executeActionForRows·payloadPOST …/{leadsUniqID}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{leadsUniqID}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{leadsUniqID}/child/smartActions/action/getActionsForRows·payloadPOST …/{leadsUniqID}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{leadsUniqID}/child/smartActions/action/getEntitiesPOST …/{leadsUniqID}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{leadsUniqID}/child/smartActions/action/processMassAction·payloadPOST …/{leadsUniqID}/child/smartActions/{UserActionId}/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/leadsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
LeadsFinderByContactIdfor 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:AddrElementAttribute1, notaddrelementattribute1. - 29 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.