Deal Registrations
deals Based on latest (2026.09)
Create, change and look up Deal Registrations, with deal approval history, deal product and deal resources. Actions include auto sync deal size and product amount total and calculate product amount total.
The record key dealsUniqID 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)56 actions
- Record key
dealsUniqID- Required on create
- none marked
- At a glance
- 110 fields6 finders25 children
- Extra parameters
?effectiveDate=Effective-Of:
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/deals?fields=AccountPartyNumber,ApprovalTaskStatusCode,ApprovedByPartyName,ApprovedDate,CloseDate&limit=25&onlyData=true
{
"items": [
{
"AccountPartyNumber": "<string, max 30>",
"ApprovalTaskStatusCode": "<string>",
"ApprovedByPartyName": "<string, max 255>",
"ApprovedDate": "2026-01-31",
"CloseDate": "2026-01-31"
}
],
"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 110
| Attribute | Type | Use |
|---|---|---|
AccountPartyNumber | text · max 30 | Read-onlySearchable |
ApprovalTaskStatusCode | text | Optional on createUpdatable |
ApprovedByPartyName | text · max 255 | Read-only |
ApprovedDate | date | Optional on createUpdatable |
CloseDate | date | Optional on createUpdatableSearchable |
CombinedConPrPhone | text · max 255 | Read-onlySearchable |
ConPrPhoneAreaCode | text · max 10 | Optional on createUpdatable |
ConPrPhoneCountryCode | text · max 10 | Optional on createUpdatable |
ConPrPhoneNumber | text · max 40 | Optional on createUpdatable |
ContactEmailAddress | text · max 320 | Optional on createUpdatableSearchable |
ContactFirstName | text · max 150 | Optional on createUpdatable |
ContactId | number | Optional on createUpdatable |
ContactJobTitle | text · max 100 | Optional on createUpdatable |
ContactLastName | text · max 150 | Optional on createUpdatable |
ContactName | text · max 900 | Optional on createUpdatable |
ContactPartyNumber | text · max 30 | Read-onlySearchable |
CreatedBy | text · max 64 | Read-only |
CreationDate | date-time | Read-onlySearchable |
CurrencyCode | text · max 20 | Optional on createUpdatable |
CustomerFormattedAddress | text | Optional on createUpdatable |
CustomerId | number | Optional on createUpdatable |
CustomerLocationAddrElementAttribute1 | text | Optional on createUpdatable |
CustomerLocationAddrElementAttribute2 | text | Optional on createUpdatable |
CustomerLocationAddrElementAttribute3 | text | Optional on createUpdatable |
CustomerLocationAddrElementAttribute4 | text | Optional on createUpdatable |
CustomerLocationAddrElementAttribute5 | text | Optional on createUpdatable |
CustomerLocationAddress1 | text | Optional on createUpdatable |
CustomerLocationAddress2 | text | Optional on createUpdatable |
CustomerLocationAddress3 | text | Optional on createUpdatable |
CustomerLocationAddress4 | text | Optional on createUpdatable |
CustomerLocationAddressLinesPhonetic | text | Optional on createUpdatable |
CustomerLocationBuilding | text | Optional on createUpdatable |
CustomerLocationCity | text | Optional on createUpdatableSearchable |
CustomerLocationCountry | text | Optional on createUpdatableSearchable |
CustomerLocationCounty | text | Optional on createUpdatable |
CustomerLocationFloorNumber | text | Optional on createUpdatable |
CustomerLocationPostalCode | text | Optional on createUpdatableSearchable |
CustomerLocationPostalPlus4Code | text | Optional on createUpdatable |
CustomerLocationProvince | text | Optional on createUpdatable |
CustomerLocationState | text | Optional on createUpdatableSearchable |
CustomerName | text · max 900 | Optional on createUpdatable |
CustomerPartyType | text · max 30 | Read-only |
DealApprovedBy | text | Optional on createUpdatable |
DealContactName | text · max 360 | Optional on createUpdatable |
DealCustomerName | text · max 360 | Optional on createUpdatable |
DealExpirationDate | date | Optional on createUpdatableSearchable |
DealId | number | Optional on createSearchable |
DealName | text · max 250 | Optional on createUpdatableSearchable |
DealNumber | text · max 30 | Optional on createSearchable |
DealRejectedBy | text | Optional on createUpdatable |
DealRejectedComments | text · max 250 | Optional on createUpdatable |
DealRejectedReasonCode | text · max 30 | Optional on createUpdatable |
DealReturnComments | text · max 250 | Optional on createUpdatable |
DealReturnReasonCode | text · max 30 | Optional on createUpdatable |
DealReturnedBy | text | Optional on createUpdatable |
DealSize | number | Optional on createUpdatableSearchable |
DealSubmittedBy | number | Read-only |
DealType | text · max 30 · default ORA_NEW | Optional on createUpdatable |
DealWithdrawnBy | text | Optional on createUpdatable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-only |
LastUpdatedBy | text · max 64 | Read-only |
LeadId | number | Optional on createUpdatableSearchable |
LeadName | text · max 250 | Read-only |
LeadNumber | text · max 30 | Optional on createUpdatableSearchable |
ManageApprovalDataFlag | yes/no | Read-only |
ManageGeneralDataFlag | yes/no | Read-only |
ManageOpptyDataFlag | yes/no | Read-only |
ManagePartnerDataFlag | yes/no | Read-only |
ManageTeamDataFlag | yes/no | Read-only |
MatchedAccountPartyId | number | Optional on createUpdatable |
MatchedAccountPartyNumber | text · max 30 | Read-onlySearchable |
MatchedAccountPartyUniqueName | text · max 900 | Read-only |
MatchedContactPartyId | number | Optional on createUpdatable |
MatchedContactPartyName | text · max 360 | Read-only |
MatchedContactPartyNumber | text · max 30 | Read-onlySearchable |
NotesSourceObjectCode | text | Read-only |
OptyId | number | Optional on createUpdatableSearchable |
OptyName | text · max 275 | Read-only |
OptyNumber | text · max 30 | Optional on createUpdatableSearchable |
OwnerId | number | Optional on createUpdatableSearchable |
OwnerPartyName | text · max 360 | Optional on createUpdatable |
OwnerPartyNumber | text · max 30 | Read-onlySearchable |
PartnerCompanyNumber | text · max 30 | Optional on createSearchable |
PartnerId | number | Optional on createUpdatableSearchable |
PartnerLevel | text · max 50 | Read-only |
PartnerOwnerId | number | Read-only |
PartnerOwnerName | text · max 450 | Read-onlySearchable |
PartnerPartyName | text · max 360 | Optional on createUpdatableSearchable |
PartnerType | text · max 30 | Optional on createUpdatable |
ProgramEnrollmentId | number | Optional on createUpdatable |
ProgramEnrollmentNumber | text · max 30 | Read-onlySearchable |
RejectedByPartyName | text · max 255 | Read-only |
RejectedDate | date | Optional on createUpdatable |
ReturnedByPartyName | text · max 255 | Read-only |
ReturnedDate | date | Optional on createUpdatable |
SearchKey | text | Optional on createUpdatable |
StatusCode | text · max 30 · default ORA_DRAFT | Optional on createUpdatableSearchable |
SubmittedByPartyName | text · max 360 | Read-only |
SubmittedDate | date | Read-only |
UpdateFlag | yes/no | Read-only |
WithdrawnByPartyName | text · max 255 | Read-only |
WithdrawnDate | date | Optional on createUpdatable |
canApprove | yes/no | Read-only |
canCopyDeal | yes/no | Read-only |
canReject | yes/no | Read-only |
canReturn | yes/no | Read-only |
canSubmit | yes/no | Read-only |
canWithdraw | yes/no | Read-only |
isApproverFlag | yes/no | Read-only |
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 6
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
AllDealRegistrationRF·LastUpdateEndDateLastUpdateStartDateRecordSetForRestResourcePartyIdStatusCodeAllDealsSearchRF·SearchKeyDealNumberAltKey·DealNumberDealStatusCodeRF·StatusCodeDealsPendingMyApprovalRF·SearchKeyForRollup
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 25
Child resources sit under one record: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/<name>. Add them to a GET with expand.
DealApprovalHistoryGET Deal Approval Histories · 12 fieldsActionByActionByDisplayActionCodeActionDateAssigneeAssigneeDisplayNameAssigneeTypeCommentTextIdentificationKeyReasonDisplayVersionVersionKeyDealAttachmentsGET · POST · PATCH · DELETE Deal Attachments · 32 fields · 1 findersAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNameDealProductGET · POST · PATCH · DELETE Deal Products · 27 fields · 1 findersAmountConvCurrencyCodeConvExchangeRateConvRateTypeCreatedByCreationDateCurrencyCodeDealIdDealNumberDealProdIdDealProdNumberInvOrgIdInventoryItemIdItemDescriptionItemNameItemNumberLastUpdateDateLastUpdateLoginLastUpdatedByProductGroupDescriptionProductGroupIdProductGroupNameProductGroupNumberProductTypeQuantityRegisteredPriceUOMCodesmartActionsGET 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 fieldsBindingSystemActionFlagURLBindingIdURLBindingNameValueDealResourcesGET · POST · PATCH · DELETE Deal Team Members · 19 fields · 2 findersAccessLevelCodeCreatedByCreationDateDealIdDealNumberDealResourceIdEmailAddressFormattedPhoneNumberLastUpdateDateLastUpdateLoginLastUpdatedByMemberFunctionCodeOwnerFlagPartnerOrgIdResourceIdResourceNameResourcePartyNumberResourceUsernameRoleNamesmartActionsGET 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 fieldsBindingSystemActionFlagURLBindingIdURLBindingNameValueMatchedOpportunityGET Opportunities · 116 fields · 2 findersAccountPartyNumberAssetIdAssetNumberAssetProductAssetSerialNumberAssignmentModeAverageDaysAtStageBatchTagBdgtAmountBdgtAmtCurcyCdBudgetAvailableDateBudgetedFlagChampionFlagClosePeriodCommentsConflictIdCreatedByCreationDateCrmConversionRateCrmCurrencyCodeCurrencyCodeCustPartyTypeCustomerAccountIdDealHorizonCodeDecisionLevelCodeDeleteFlagDescriptionDescriptionTextDownsideAmountEffectiveDateEmailAddressExpectAmountForecastCategoryForecastOverrideCodeHintCodeIBAssetIdIBAssetNumberIBAssetProductIBAssetSerialNumberKeyContactIdLastUpdateDateLastUpdateLoginLastUpdatedByLineOfBusinessCodeLookupCategoryManageGeneralProfileDataFlagManageRestrictedProfileDataFlagManageRevenueDataFlagManageTeamDataFlagMaximumDaysInStageNameOpportunityOriginOpportunityTypeCodeOptyCreatedByOptyCreationDateOptyIdOptyLastUpdateDateOptyLastUpdatedByOptyNumberOwnerPartyNumberOwnerResourcePartyIdPartyName1PartyUniqueName1PhaseCdPrSrcNumberPredWinProbPrimaryCampaignIdPrimaryCampaignNamePrimaryCampaignNumberPrimaryCompetitorIdPrimaryCompetitorPartyNumberPrimaryContactEmailAddressPrimaryContactEmailPrefPrimaryContactFormattedPhoneNumberPrimaryContactPartyNamePrimaryContactPartyNumberPrimaryContactPhonePrefPrimaryOrganizationIdPrimaryOrganizationName_transientPrimaryPartnerCompanyNumberPrimaryPartnerIdPrimaryPartnerOrgPartyNamePrimaryRevenueIdPrimarySubscriptionIdPrimarySubscriptionNumberQuotaFactorQuotedFlagRcmndWinProbReasonWonLostCodeRecommendedActionRecordSetRegisteredRegistrationStatusRegistrationTypeRenewalProcessRevenueRiskLevelCodeSalesAccountUniqueNameSalesChannelCdSalesMethodSalesMethodIdSalesStageSalesStageIdSelectedSetupRefCodeSourceTypeStageStatusCdStatusCodeStgOrderStrategicLevelCodeTargetPartyIdTargetPartyNameTargetPartyPrimaryAddressCountryUpdateFlagUpsideAmountWinProbNoteGET · 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 fieldsBindingSystemActionFlagURLBindingIdURLBindingNameValuePartnerOwnerPickerGET · POST · PATCH · DELETE Partner Owner Picker · 40 fields · 6 findersDenormLevelDenormMgrIdEmailAddressEndDateActiveFilterManagerFormattedPhoneNumberGroupIdHierarchyTypeIncludeManagerManagerFirstNameManagerLastNameManagerNameOrganizationNameParentOrgIdParentResourceIdPartyIdPartyNumberPartyTypePrimaryPhoneAreaCodePrimaryPhoneContactPtIdPrimaryPhoneCountryCodePrimaryPhoneExtensionPrimaryPhoneLineTypePrimaryPhoneNumberPrimaryPhonePurposeReportsToResourceFirstNameResourceIdResourceLastNameResourceNameResourceProfileIdResourceSearchFilterRoleNameStartDateActiveStatusTreeCodeTreeNameTreeStructureCodeTreeVersionIdUserGuidproductGroupsGET 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 fieldsBindingSystemActionFlagURLBindingIdURLBindingNameValue
Actions 56
POST …/{dealsUniqID}/action/autoSyncDealSizeAndProductAmountTotalPOST …/{dealsUniqID}/action/calculateProductAmountTotalPOST …/{dealsUniqID}/action/convertDealToOpportunityPOST …/{dealsUniqID}/action/copyDealPOST …/{dealsUniqID}/action/dealSizeOrProductAmountTotalChangedPOST …/{dealsUniqID}/action/performApprovalAction·reasoncommentsactionCodePOST …/{dealsUniqID}/action/refreshContactRowPOST …/{dealsUniqID}/action/refreshCustomerRowPOST …/{dealsUniqID}/child/DealProduct/{DealProdId}/child/smartActions/action/executeActionForRows·payloadPOST …/{dealsUniqID}/child/DealProduct/{DealProdId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{dealsUniqID}/child/DealProduct/{DealProdId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{dealsUniqID}/child/DealProduct/{DealProdId}/child/smartActions/action/getActionsForRows·payloadPOST …/{dealsUniqID}/child/DealProduct/{DealProdId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{dealsUniqID}/child/DealProduct/{DealProdId}/child/smartActions/action/getEntitiesPOST …/{dealsUniqID}/child/DealProduct/{DealProdId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{dealsUniqID}/child/DealProduct/{DealProdId}/child/smartActions/action/processMassAction·payloadPOST …/{dealsUniqID}/child/DealProduct/{DealProdId}/child/smartActions/{deals_DealProduct_smartActions_Id}/action/executeActionPOST …/{dealsUniqID}/child/DealResources/{DealResourceId}/child/smartActions/action/executeActionForRows·payloadPOST …/{dealsUniqID}/child/DealResources/{DealResourceId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{dealsUniqID}/child/DealResources/{DealResourceId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{dealsUniqID}/child/DealResources/{DealResourceId}/child/smartActions/action/getActionsForRows·payloadPOST …/{dealsUniqID}/child/DealResources/{DealResourceId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{dealsUniqID}/child/DealResources/{DealResourceId}/child/smartActions/action/getEntitiesPOST …/{dealsUniqID}/child/DealResources/{DealResourceId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{dealsUniqID}/child/DealResources/{DealResourceId}/child/smartActions/action/processMassAction·payloadPOST …/{dealsUniqID}/child/DealResources/{DealResourceId}/child/smartActions/{deals_DealResources_smartActions_Id}/action/executeActionPOST …/{dealsUniqID}/child/MatchedOpportunity/action/assignOpportunity·optyNumberPOST …/{dealsUniqID}/child/MatchedOpportunity/action/copyOpportunity·newOptyNameoptyNumberPOST …/{dealsUniqID}/child/MatchedOpportunity/action/copyOpportunityAndGetId·newOptyNameoptyNumberPOST …/{dealsUniqID}/child/MatchedOpportunity/action/createQuote·optyNumberPOST …/{dealsUniqID}/child/Note/{NoteId}/child/smartActions/action/executeActionForRows·payloadPOST …/{dealsUniqID}/child/Note/{NoteId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{dealsUniqID}/child/Note/{NoteId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{dealsUniqID}/child/Note/{NoteId}/child/smartActions/action/getActionsForRows·payloadPOST …/{dealsUniqID}/child/Note/{NoteId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{dealsUniqID}/child/Note/{NoteId}/child/smartActions/action/getEntitiesPOST …/{dealsUniqID}/child/Note/{NoteId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{dealsUniqID}/child/Note/{NoteId}/child/smartActions/action/processMassAction·payloadPOST …/{dealsUniqID}/child/Note/{NoteId}/child/smartActions/{deals_Note_smartActions_Id}/action/executeActionPOST …/{dealsUniqID}/child/productGroups/action/setUsagCode·usageCodePOST …/{dealsUniqID}/child/productGroups/action/setUsageCode·usageCodePOST …/{dealsUniqID}/child/productGroups/action/setUsageMode·usageModePOST …/{dealsUniqID}/child/productGroups/action/setUserSelectionForTM·valuePOST …/{dealsUniqID}/child/products/action/setSelectedProductGroupId·prodGroupIdPOST …/{dealsUniqID}/child/products/action/setUsageCode·usageCodePOST …/{dealsUniqID}/child/products/action/setUsageMode·usageModePOST …/{dealsUniqID}/child/products/action/setUserSelectionForTM·valuePOST …/{dealsUniqID}/child/smartActions/action/executeActionForRows·payloadPOST …/{dealsUniqID}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{dealsUniqID}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{dealsUniqID}/child/smartActions/action/getActionsForRows·payloadPOST …/{dealsUniqID}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{dealsUniqID}/child/smartActions/action/getEntitiesPOST …/{dealsUniqID}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{dealsUniqID}/child/smartActions/action/processMassAction·payloadPOST …/{dealsUniqID}/child/smartActions/{deals_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/dealsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
AllDealRegistrationRFfor 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:ApprovalTaskStatusCode, notapprovaltaskstatuscode. - 41 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.