Contacts
contacts Based on latest (2026.09)
Create, change, delete and look up Contacts, with additional identifier, additional name and address. Actions include find duplicates and person DEO change customer in picker.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE77 actions
- Record key
PartyNumber- Required on create
AddressNumberCountryPartyNumberPartyNumberKey- At a glance
- 188 fields5 finders47 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/contacts?fields=AcademicTitle,AccountName,AccountPartyId,AccountPartyNumber,AccountSalesAccountFlag&limit=25&onlyData=true
{
"items": [
{
"AcademicTitle": "<string, max 30>",
"AccountName": "<string, max 360>",
"AccountPartyId": 0,
"AccountPartyNumber": "<string, max 30>",
"AccountSalesAccountFlag": false
}
],
"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 188
| Attribute | Type | Use |
|---|---|---|
AcademicTitle | text · max 30 | Optional on createUpdatableSearchable |
AccountName | text · max 360 | Read-onlySearchable |
AccountPartyId | number | Optional on createUpdatableSearchable |
AccountPartyNumber | text · max 30 | Read-onlySearchable |
AccountSalesAccountFlag | yes/no · max 10 · default false | Read-onlySearchable |
AccountSourceSystem | text | Optional on createUpdatableSearchable |
AccountSourceSystemReferenceValue | text | Optional on createUpdatableSearchable |
AccountUniqueName | text · max 900 | Read-onlySearchable |
AddressElementAttribute1 | text · max 150 | Optional on createUpdatableSearchable |
AddressElementAttribute2 | text · max 150 | Optional on createUpdatableSearchable |
AddressElementAttribute3 | text · max 150 | Optional on createUpdatableSearchable |
AddressElementAttribute4 | text · max 150 | Optional on createUpdatableSearchable |
AddressElementAttribute5 | text · max 150 | Optional on createUpdatableSearchable |
AddressLine1 | text · max 240 | Optional on createUpdatableSearchable |
AddressLine2 | text · max 240 | Optional on createUpdatableSearchable |
AddressLine3 | text · max 240 | Optional on createUpdatableSearchable |
AddressLine4 | text · max 240 | Optional on createUpdatableSearchable |
AddressLinesPhonetic | text · max 560 | Optional on createUpdatableSearchable |
AddressNumber | text · max 30 | Required on createSearchable |
AddressType | text | Optional on createUpdatable |
AssignmentExceptionFlag | yes/no · max 1 · default false | Read-only |
Building | text · max 240 | Optional on createUpdatableSearchable |
CertificationLevel | text · max 30 | Optional on createUpdatableSearchable |
CertificationReasonCode | text · max 30 | Optional on createUpdatableSearchable |
City | text · max 60 | Optional on createUpdatableSearchable |
ClassificationCategory | text | Optional on createUpdatable |
ClassificationCode | text | Optional on createUpdatable |
Comments | text · max 2000 | Optional on createUpdatableSearchable |
ConflictId | number · default 0 | Optional on createUpdatableSearchable |
ContactIsPrimaryForAccount | text | Optional on createUpdatableSearchable |
ContactName | text · max 450 | Read-onlySearchable |
ContactRole | text · max 60 | Optional on createUpdatableSearchable |
ContactUniqueName | text · max 900 | Read-onlySearchable |
Country | text · max 2 | Required on createUpdatableSearchable |
County | text · max 60 | Optional on createUpdatableSearchable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreatedByModule | text · default HZ_WS | Optional on createUpdatable |
CreationDate | date-time | Read-onlySearchable |
CurrencyCode | text · max 15 | Optional on createUpdatable |
CustomerPartyType | text · max 30 | Read-onlySearchable |
DataCloudStatus | text · max 30 | Optional on createUpdatableSearchable |
DateOfBirth | date | Optional on createUpdatableSearchable |
DateOfDeath | date | Optional on createUpdatableSearchable |
DeceasedFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
DeclaredEthnicity | text · max 60 | Optional on createUpdatableSearchable |
DeleteFlag | yes/no | Read-only |
Department | text · max 60 | Optional on createUpdatableSearchable |
DepartmentCode | text · max 30 | Optional on createUpdatableSearchable |
DoCallHomePhoneFlag | yes/no · max 10 | Optional on createUpdatable |
DoCallMobilePhoneFlag | yes/no · max 10 | Optional on createUpdatable |
DoCallPrimaryPhoneFlag | yes/no · max 255 | Optional on createUpdatable |
DoCallWorkPhoneFlag | yes/no · max 10 | Optional on createUpdatable |
DoContactEmailFlag | yes/no · max 10 | Optional on createUpdatable |
DoContactFaxFlag | yes/no · max 10 | Optional on createUpdatable |
DoNotCallFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
DoNotCallHomePhoneFlag | yes/no · max 255 | Optional on createUpdatable |
DoNotCallMobileFlag | yes/no · max 255 | Optional on createUpdatable |
DoNotCallPrimaryPhoneFlag | yes/no · max 255 | Optional on createUpdatable |
DoNotCallWorkPhoneFlag | yes/no · max 255 | Optional on createUpdatable |
DoNotContactEmailFlag | yes/no · max 255 | Optional on createUpdatable |
DoNotContactFaxFlag | yes/no · max 255 | Optional on createUpdatable |
DoNotContactFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
DoNotEmailFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
DoNotMailFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
EmailAddress | text · max 320 | Optional on createUpdatableSearchable |
EmailContactPointType | text · max 30 · default EMAIL | Read-onlySearchable |
EmailContactPtId | text | Read-only |
EmailFormat | text · max 30 | Optional on createUpdatableSearchable |
EmailVerificationDate | date | Optional on createUpdatable |
EmailVerificationStatus | text · max 30 | Optional on createUpdatable |
ExistingCustomerFlag | yes/no · max 1 · default false | Read-only |
ExistingCustomerFlagLastUpdateDate | date | Read-only |
FavoriteContactFlag | yes/no · max 10 · default false | Optional on createUpdatableSearchable |
FaxAreaCode | text · max 20 | Optional on createUpdatableSearchable |
FaxContactPointType | text · max 30 · default PHONE | Read-onlySearchable |
FaxContactPtId | text | Read-only |
FaxCountryCode | text · max 10 | Optional on createUpdatableSearchable |
FaxExtension | text · max 20 | Optional on createUpdatableSearchable |
FaxNumber | text · max 40 | Optional on createUpdatableSearchable |
FaxVerificationDate | date | Optional on createUpdatable |
FaxVerificationStatus | text · max 30 | Optional on createUpdatable |
FirstName | text · max 150 | Optional on createUpdatableSearchable |
FloorNumber | text · max 40 | Optional on createUpdatableSearchable |
FormattedAddress | text | Read-only |
FormattedFaxNumber | text | Read-only |
FormattedHomePhoneNumber | text | Read-only |
FormattedMobileNumber | text | Read-only |
FormattedWorkPhoneNumber | text | Read-only |
Gender | text · max 30 | Optional on createUpdatableSearchable |
HeadOfHouseholdFlag | yes/no · max 1 · default false | Optional on createUpdatableSearchable |
HomePhoneAreaCode | text · max 20 | Optional on createUpdatableSearchable |
HomePhoneContactPointType | text · max 30 · default PHONE | Read-onlySearchable |
HomePhoneContactPtId | text | Read-only |
HomePhoneCountryCode | text · max 10 | Optional on createUpdatableSearchable |
HomePhoneNumber | text · max 40 | Optional on createUpdatableSearchable |
HomePhoneVerificationDate | date | Optional on createUpdatable |
HomePhoneVerificationStatus | text · max 30 | Optional on createUpdatable |
HouseholdContactRole | text | Optional on createUpdatable |
HouseholdIncomeAmount | number | Optional on createUpdatableSearchable |
HouseholdPartyId | number | Optional on createUpdatableSearchable |
HouseholdPartyNumber | text · max 30 | Read-onlySearchable |
HouseholdSize | number | Optional on createUpdatableSearchable |
HouseholdSourceSystem | text | Optional on createUpdatableSearchable |
HouseholdSourceSystemReferenceValue | text | Optional on createUpdatableSearchable |
HouseholdUniqueName | text · max 900 | Read-onlySearchable |
Initials | text · max 20 | Optional on createUpdatableSearchable |
JobTitle | text · max 100 | Optional on createUpdatableSearchable |
JobTitleCode | text · max 30 | Optional on createUpdatableSearchable |
LastAssignmentDate | date | Read-onlySearchable |
LastContactDate | date-time | Optional on createUpdatableSearchable |
LastEnrichmentDate | date | Optional on createUpdatableSearchable |
LastKnownGPS | text · max 60 | Optional on createUpdatableSearchable |
LastName | text · max 150 | Optional on createUpdatableSearchable |
LastNamePrefix | text · max 30 | Optional on createUpdatableSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
Mailstop | text · max 60 | Optional on createUpdatableSearchable |
MaritalStatus | text · max 30 | Optional on createUpdatableSearchable |
MaritalStatusEffectiveDate | date | Optional on createUpdatableSearchable |
MiddleName | text · max 60 | Optional on createUpdatableSearchable |
MobileAreaCode | text · max 20 | Optional on createUpdatableSearchable |
MobileContactPointType | text · max 30 · default PHONE | Read-onlySearchable |
MobileCountryCode | text · max 10 | Optional on createUpdatableSearchable |
MobileExtension | text · max 20 | Optional on createUpdatableSearchable |
MobileNumber | text · max 40 | Optional on createUpdatableSearchable |
MobilePhoneContactPtId | text | Read-only |
MobileVerificationDate | date | Optional on createUpdatable |
MobileVerificationStatus | text · max 30 | Optional on createUpdatable |
NameSuffix | text · max 30 | Optional on createUpdatableSearchable |
NamedFlag | yes/no · max 1 · default false | Optional on createUpdatableSearchable |
OverallPrimaryFormattedPhoneNumber | text | Read-only |
OverallPrimaryPhoneContactPtId | number | Read-only |
OwnerEmailAddress | text · max 320 | Read-onlySearchable |
OwnerName | text · max 360 | Read-onlySearchable |
OwnerPartyId | number | Optional on createUpdatableSearchable |
OwnerPartyNumber | text · max 30 | Read-onlySearchable |
PartyId | number | Read-onlySearchable |
PartyNumber | text · max 30 | Required on createSearchable |
PartyNumberKey | text · max 30 | Required on createUpdatableSearchable |
PartyStatus | text · max 1 · default A | Read-onlySearchable |
PartyType | text · max 30 · default PERSON | Read-onlySearchable |
PersonProfileId | number | Read-onlySearchable |
PersonalIncomeAmount | number | Optional on createUpdatableSearchable |
PlaceOfBirth | text · max 60 | Optional on createUpdatableSearchable |
PostalCode | text · max 60 | Optional on createUpdatableSearchable |
PostalPlus4Code | text · max 20 | Optional on createUpdatableSearchable |
PreferredContactMethod | text · max 30 | Optional on createUpdatableSearchable |
PreferredFunctionalCurrency | text · max 15 | Optional on createUpdatableSearchable |
PreviousLastName | text · max 150 | Optional on createUpdatableSearchable |
PrimaryAddressId | number | Read-onlySearchable |
PrimaryPhoneVerificationDate | date | Optional on createUpdatable |
PrimaryPhoneVerificationStatus | text · max 30 | Optional on createUpdatable |
Province | text · max 60 | Optional on createUpdatableSearchable |
RawFaxNumber | text · max 60 | Optional on createUpdatableSearchable |
RawHomePhoneNumber | text · max 60 | Optional on createUpdatableSearchable |
RawMobileNumber | text · max 60 | Optional on createUpdatableSearchable |
RawPhoneNumber | text · max 60 | Optional on createUpdatableSearchable |
RawWorkPhoneNumber | text · max 60 | Optional on createUpdatableSearchable |
RecordSet | text · max 30 | Optional on createUpdatableSearchable |
RegistrationStatus | text · max 30 | Optional on createUpdatableSearchable |
RentOrOwnIndicator | text · max 30 | Optional on createUpdatableSearchable |
SalesAffinityCode | text · max 30 | Optional on createUpdatableSearchable |
SalesBuyingRoleCode | text · max 30 | Optional on createUpdatableSearchable |
SalesProfileNumber | text · max 30 | Optional on createUpdatableSearchable |
SalesProfileStatus | text · max 30 | Optional on createUpdatableSearchable |
Salutation | text · max 60 | Optional on createUpdatableSearchable |
SalutoryIntroduction | text · max 30 | Optional on createUpdatableSearchable |
SecondLastName | text · max 150 | Optional on createUpdatableSearchable |
SellToPartySiteId | number | Read-onlySearchable |
SourceObjectType | text · max 255 · default SALES_PARTY_CONTACT | Read-only |
SourceSystem | text | Optional on createUpdatableSearchable |
SourceSystemReferenceValue | text | Optional on createUpdatableSearchable |
State | text · max 60 | Optional on createUpdatableSearchable |
TaxpayerIdentificationNumber | text · max 20 | Optional on createUpdatableSearchable |
TimezoneCode | text · max 64 | Optional on createUpdatableSearchable |
Title | text · max 60 | Optional on createUpdatableSearchable |
Type | text · max 30 | Optional on createUpdatableSearchable |
UniqueNameSuffix | text · max 540 | Optional on createUpdatableSearchable |
UpdateFlag | yes/no | Read-only |
WorkPhoneAreaCode | text · max 20 | Optional on createUpdatableSearchable |
WorkPhoneContactPointType | text · max 30 · default PHONE | Read-onlySearchable |
WorkPhoneContactPtId | text | Read-only |
WorkPhoneCountryCode | text · max 10 | Optional on createUpdatableSearchable |
WorkPhoneExtension | text · max 20 | Optional on createUpdatableSearchable |
WorkPhoneNumber | text · max 40 | Optional on createUpdatableSearchable |
WorkPhoneVerificationDate | date | Optional on createUpdatable |
WorkPhoneVerificationStatus | text · max 30 | Optional on createUpdatable |
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 5
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
ContactPartyNumberRF·PartyNumberMyBusinessContactsMyContacts·BindUserPartyIdMyFavoriteContactsSourceSystemReferenceAltKey·SourceSystemSourceSystemReferenceValue
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 47
Child resources sit under one record: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/<name>. Add them to a GET with expand.
AdditionalIdentifierGET · POST · PATCH · DELETE Additional Identifiers · 24 fieldsCountryCreatedByCreatedByModuleCreationDateDescriptionExpirationDateIssueDateIssuingAuthorityNameIssuingAuthorityPartyIdLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberPartyIdPartyIdentifierIdPartyIdentifierTypePartyIdentifierValuePartyNumberPartySourceSystemPartySourceSystemReferenceValueSourceSystemSourceSystemReferenceValueStateProvinceStatusCodesmartActionsGET 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 fieldsBindingSystemActionFlagURLBindingIdURLBindingNameValueAdditionalNameGET · POST · PATCH · DELETE Additional Names · 23 fieldsAcademicTitleConflictIdCreatedByCreationDateDescriptionFirstNameLastNameLastUpdateDateLastUpdatedByMiddleNameNameNameIdNameTypePartyIdPartyNumberPartySourceSystemPartySourceSystemReferenceValuePreferredFlagSourceSystemSourceSystemReferenceValueStatusFlagTitleTransliterationLanguagesmartActionsGET 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 fieldsBindingSystemActionFlagURLBindingIdURLBindingNameValueAddressGET · POST · PATCH · DELETE Contact Addresses · 73 fields · 4 findersAddrElementAttribute1AddrElementAttribute2AddrElementAttribute3AddrElementAttribute4AddrElementAttribute5Address1Address2Address3Address4AddressIdAddressLinesPhoneticAddressNumberAddressTypeBuildingCalculateFormattedAddressCityClliCodeCommentsConflictIdCorpCurrencyCodeCountryCountyCreatedByCreatedByModuleCreatedByModule1CreationDateCurcyConvRateTypeCurrencyCodeDateValidatedDescriptionDoNotMailFlagDoNotValidateFlagDunsNumberCEffectiveDateEndDateActiveFloorNumberFormattedAddressFormattedAddress1FormattedMultilineAddressFormattedMultilineAddress1HouseTypeLastUpdateDateLastUpdateLoginLastUpdatedByLatitudeLocationDirectionsLocationIdLongitudeMailstopObjectVersionNumberObjectVersionNumber1PartyIdPartyNamePartyNumberPartySiteNamePartySourceSystemPartySourceSystemReferenceValuePartyUniqueNamePostalCodePostalPlus4CodePrimaryFlagProvinceSSROwnerTableNameSSRPartyOwnerTableNameSalesAccountFlagSourceSystemSourceSystemReferenceValueStartDateActiveStateStatusValidatedFlagValidationStartDateValidationStatusCodeAddressLocaleGET · POST · PATCH · DELETE Address Locales · 30 fields · 1 findersAddrElementAttribute1AddrElementAttribute2AddrElementAttribute3AddrElementAttribute4AddrElementAttribute5Address1Address2Address3Address4AddressNumberBuildingCityCountryCountyCreatedByCreationDateFloorNumberFormattedAddressLastUpdateDateLastUpdateLoginLastUpdatedByLocationIdLocationLocaleIdPostalCodePostalPlus4codeProvinceSiteSourceSystemSiteSourceSystemReferenceValueStateTransliterationLanguageAddressPurposeGET · POST · PATCH · DELETE Contact Address Purposes · 20 fields · 1 findersAddressIdAddressNumberAddressPurposeIdCommentsCreatedByCreatedByModuleCreationDateDeleteFlagEndDateLastUpdateDateLastUpdateLoginLastUpdatedByPrimaryPerTypePurposeSiteSourceSystemSiteSourceSystemReferenceValueSourceSystemSourceSystemReferenceValueStartDateStatussmartActionsGET 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 fieldsBindingSystemActionFlagURLBindingIdURLBindingNameValueAttachmentGET · POST · PATCH · DELETE Contact Attachments · 34 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoEntityNameErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageInternalDocumentIdLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNameContactPointGET · POST · PATCH · DELETE Contact Points · 39 fieldsConflictIdContactPointIdContactPointTypeCreatedByCreatedByModuleCreationDateDoContactPreferenceFlagDoNotContactPreferenceFlagDoNotContactReasonEmailAddressEmailPurposeFormattedPhoneNumberLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberPartyIdPartyNumberPartySourceSystemPartySourceSystemReferenceValuePhoneAreaCodePhoneCountryCodePhoneExtensionPhoneNumberPhonePurposePhoneTypePreferenceRequestedByPrimaryFlagRawPhoneNumberSocialNetworkIdSocialNetworkNameSocialNetworkPurposeSourceSystemSourceSystemReferenceValueStatusURLVerificationDateVerificationStatusWebPurposesmartActionsGET 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 fieldsBindingSystemActionFlagURLBindingIdURLBindingNameValueContactRollupGET Contact Rollups · 25 fields · 1 findersCallsMadeCorpCurrencyCodeCreatedByCreationDateEmailsSentLastCallMadeDateLastCompletedActivityLastEmailSentDateLastResponseLastTouchDateLastUpdateDateLastUpdateLoginLastUpdatedByNextTaskDueNumberOfOpenActivitiesNumberOfOpenCriticalServiceRequestsNumberOfOpenHotLeadsNumberOfOpenLeadsNumberOfOpenOpportunitiesNumberOfOpenServiceRequestsNumberOfResponsesNumberOfTouchesPersonProfileIdSumOfOpenOpportunitiesRevenueTotalNotesCustomerClassificationGET · POST · PATCH · DELETE Aux Classifications · 25 fieldsClassCategoryClassCodeClassCodeMeaningCodeAssignmentIdConflictIdCreatedByCreatedByModuleCreationDateEndDateActiveIsAuxClassificationFlagIsIndustryFlagIsOrgTypeFlagLastUpdateDateLastUpdateLoginLastUpdatedByPartyIdPartyNumberPartySourceSystemPartySourceSystemReferenceValuePartyTypePrimaryFlagSourceSystemSourceSystemReferenceValueStartDateActiveStatusNoteGET · 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 fieldsBindingSystemActionFlagURLBindingIdURLBindingNameValuePictureAttachmentGET · POST · PATCH · DELETE Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNamePrimaryAddressGET · POST · PATCH · DELETE Contact Primary Addresses · 65 fields · 1 findersAddressElementAttribute1AddressElementAttribute2AddressElementAttribute3AddressElementAttribute4AddressElementAttribute5AddressIdAddressLine1AddressLine2AddressLine3AddressLine4AddressLinesPhoneticAddressNumberAddresseeBuildingCityCommentsConflictIdCorpCurrencyCodeCountryCountyCreatedByCreationDateCurcyConvRateTypeCurrencyCodeDateValidatedDeleteFlagDescriptionDoNotValidateFlagEndDateActiveFloorNumberFormattedAddressFormattedMultiLineAddressHouseTypeLastUpdateDateLastUpdateLoginLastUpdatedByLatitudeLocationCommentsLocationDirectionsLocationIdLocationIntegrationKeyLocationLocationIdLocationSourceSystemLocationSourceSystemReferenceValueLocationStatusFlagLongitudeMailstopObjectVersionNumberLocationObjectVersionNumberPartySiteOverallPrimaryFlagPartyIdPartySiteNamePartySiteTypePostalCodePostalPlus4CodeProvinceShortDescriptionSourceSystemSourceSystemReferenceValueStartDateActiveStateStatusTimezoneCodeValidatedFlagValidationStatusCodeRelationshipGET · POST · PATCH · DELETE Relationships · 56 fields · 9 findersBackwardRoleBackwardRoleDescriptionCommentsConflictIdCreatedByCreatedByModuleCreationDateDependentFlagDirectionCodeEndDateHeadOfHouseholdFlagInfluenceLevelIsObjectSalesPartyFlagIsSubjectSalesPartyFlagJobDefinitionNameJobDefinitionPackageLastUpdateDateLastUpdateLoginLastUpdatedByObjectPartyIdObjectPartyNameObjectPartyNumberObjectSourceSystemObjectSourceSystemReferenceValueObjectTableNameObjectTypeObjectUsageCodeObjectVersionNumberObjectVersionNumber1ObjectVersionNumber2PartyIdPartyId1PercentageOwnershipPreferredContactFlagPrimaryCustomerFlagRelationshipCodeRelationshipGroupRelationshipIdRelationshipRecIdRelationshipSourceSystemRelationshipSourceSystemReferenceValueRelationshipTypeRequestIdRoleRoleDescriptionSSROwnerTableNameStartDateStatusSubjectPartyIdSubjectPartyNameSubjectPartyNumberSubjectSourceSystemSubjectSourceSystemReferenceValueSubjectTableNameSubjectTypeSubjectUsageCodesmartActionsGET 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 fieldsBindingSystemActionFlagURLBindingIdURLBindingNameValueSalesTeamMemberGET · POST · PATCH · DELETE Sales Account Resources · 30 fields · 1 findersAccessLevelCodeAssignmentTypeCodeCorpCurrencyCodeCreatedByCreationDateCurcyConvRateTypeCurrencyCodeEndDateActiveLastUpdateDateLastUpdateLoginLastUpdatedByLockAssignmentFlagMemberFunctionCodeObjectVersionNumberOwnerFlagPartyIdPartyNumberPartySourceSystemPartySourceSystemReferenceValueResourceEmailAddressResourceIdResourceNameResourceOrgNameResourcePartyNumberResourcePhoneNumberResourceRoleNameSalesProfileIdStartDateActiveTeamMemberIdUserLastUpdateDatesmartActionsGET 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 fieldsBindingSystemActionFlagURLBindingIdURLBindingNameValueSourceSystemReferenceGET · POST · PATCH · DELETE Source System References · 18 fieldsConflictIdCreatedByCreatedByModuleCreationDateEndDateLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberPartyIdPartyNumberPartySourceSystemPartySourceSystemReferenceValueSourceSystemSourceSystemReferenceIdSourceSystemReferenceValueStartDateStatussmartActionsGET 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 fieldsBindingSystemActionFlagURLBindingIdURLBindingNameValue
Actions 77
POST …/action/findDuplicates·contactaccountPartyNumberPOST …/{PartyNumber}/action/PersonDEO_changeCustomerInPicker·customerPartyTyperelationshipIdcustomerNamecustomerPartyIdPOST …/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}/child/smartActions/action/executeActionForRows·payloadPOST …/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}/child/smartActions/action/getActionsForRows·payloadPOST …/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}/child/smartActions/action/getEntitiesPOST …/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}/child/smartActions/action/processMassAction·payloadPOST …/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}/child/smartActions/{contacts_AdditionalIdentifier_smartActions_Id}/action/executeActionPOST …/{PartyNumber}/child/AdditionalName/{NameId}/child/smartActions/action/executeActionForRows·payloadPOST …/{PartyNumber}/child/AdditionalName/{NameId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{PartyNumber}/child/AdditionalName/{NameId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{PartyNumber}/child/AdditionalName/{NameId}/child/smartActions/action/getActionsForRows·payloadPOST …/{PartyNumber}/child/AdditionalName/{NameId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{PartyNumber}/child/AdditionalName/{NameId}/child/smartActions/action/getEntitiesPOST …/{PartyNumber}/child/AdditionalName/{NameId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{PartyNumber}/child/AdditionalName/{NameId}/child/smartActions/action/processMassAction·payloadPOST …/{PartyNumber}/child/AdditionalName/{NameId}/child/smartActions/{contacts_AdditionalName_smartActions_Id}/action/executeActionPOST …/{PartyNumber}/child/Address/{AddressNumber}/action/PartySiteEO_setCurrentOverallPrimaryFlagPOST …/{PartyNumber}/child/Address/{AddressNumber}/action/PartySiteEO_setCurrentPrimaryFlagPOST …/{PartyNumber}/child/Address/{AddressNumber}/child/smartActions/action/executeActionForRows·payloadPOST …/{PartyNumber}/child/Address/{AddressNumber}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{PartyNumber}/child/Address/{AddressNumber}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{PartyNumber}/child/Address/{AddressNumber}/child/smartActions/action/getActionsForRows·payloadPOST …/{PartyNumber}/child/Address/{AddressNumber}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{PartyNumber}/child/Address/{AddressNumber}/child/smartActions/action/getEntitiesPOST …/{PartyNumber}/child/Address/{AddressNumber}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{PartyNumber}/child/Address/{AddressNumber}/child/smartActions/action/processMassAction·payloadPOST …/{PartyNumber}/child/Address/{AddressNumber}/child/smartActions/{contacts_Address_smartActions_Id}/action/executeActionPOST …/{PartyNumber}/child/ContactPoint/{ContactPointId}/child/smartActions/action/executeActionForRows·payloadPOST …/{PartyNumber}/child/ContactPoint/{ContactPointId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{PartyNumber}/child/ContactPoint/{ContactPointId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{PartyNumber}/child/ContactPoint/{ContactPointId}/child/smartActions/action/getActionsForRows·payloadPOST …/{PartyNumber}/child/ContactPoint/{ContactPointId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{PartyNumber}/child/ContactPoint/{ContactPointId}/child/smartActions/action/getEntitiesPOST …/{PartyNumber}/child/ContactPoint/{ContactPointId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{PartyNumber}/child/ContactPoint/{ContactPointId}/child/smartActions/action/processMassAction·payloadPOST …/{PartyNumber}/child/ContactPoint/{ContactPointId}/child/smartActions/{contacts_ContactPoint_smartActions_Id}/action/executeActionPOST …/{PartyNumber}/child/Note/{NoteId}/child/smartActions/action/executeActionForRows·payloadPOST …/{PartyNumber}/child/Note/{NoteId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{PartyNumber}/child/Note/{NoteId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{PartyNumber}/child/Note/{NoteId}/child/smartActions/action/getActionsForRows·payloadPOST …/{PartyNumber}/child/Note/{NoteId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{PartyNumber}/child/Note/{NoteId}/child/smartActions/action/getEntitiesPOST …/{PartyNumber}/child/Note/{NoteId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{PartyNumber}/child/Note/{NoteId}/child/smartActions/action/processMassAction·payloadPOST …/{PartyNumber}/child/Note/{NoteId}/child/smartActions/{contacts_Note_smartActions_Id}/action/executeActionPOST …/{PartyNumber}/child/Relationship/{RelationshipRecId}/action/RelationshipEO_setPreferredContactIdPOST …/{PartyNumber}/child/Relationship/{RelationshipRecId}/child/smartActions/action/executeActionForRows·payloadPOST …/{PartyNumber}/child/Relationship/{RelationshipRecId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{PartyNumber}/child/Relationship/{RelationshipRecId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{PartyNumber}/child/Relationship/{RelationshipRecId}/child/smartActions/action/getActionsForRows·payloadPOST …/{PartyNumber}/child/Relationship/{RelationshipRecId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{PartyNumber}/child/Relationship/{RelationshipRecId}/child/smartActions/action/getEntitiesPOST …/{PartyNumber}/child/Relationship/{RelationshipRecId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{PartyNumber}/child/Relationship/{RelationshipRecId}/child/smartActions/action/processMassAction·payloadPOST …/{PartyNumber}/child/Relationship/{RelationshipRecId}/child/smartActions/{contacts_Relationship_smartActions_Id}/action/executeActionPOST …/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}/child/smartActions/action/executeActionForRows·payloadPOST …/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}/child/smartActions/action/getActionsForRows·payloadPOST …/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}/child/smartActions/action/getEntitiesPOST …/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}/child/smartActions/action/processMassAction·payloadPOST …/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}/child/smartActions/{contacts_SalesTeamMember_smartActions_Id}/action/executeActionPOST …/{PartyNumber}/child/smartActions/action/executeActionForRows·payloadPOST …/{PartyNumber}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{PartyNumber}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{PartyNumber}/child/smartActions/action/getActionsForRows·payloadPOST …/{PartyNumber}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{PartyNumber}/child/smartActions/action/getEntitiesPOST …/{PartyNumber}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{PartyNumber}/child/smartActions/action/processMassAction·payloadPOST …/{PartyNumber}/child/smartActions/{contacts_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/contactsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
ContactPartyNumberRFfor 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:AcademicTitle, notacademictitle. - 47 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.