1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Accounts
  4. Contact Points

Update a contact point

patch

/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/ContactPoint/{ContactPointId}

Request

Path Parameters
  • The unique identifier of the contact point.
  • The unique alternate identifier for the account party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number. Inactive records can't be updated.
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Conflict ID
    Default Value: 0
    The unique identifier of the conflict.
  • Title: Created by Application
    Default Value: HZ_WS
    The user who created the module.
  • Title: OK to Contact
    Indicates whether to use a particular contact method. Defaulted to false.
  • Title: Do Not Contact
    The contact preference flag that indicates DNC option.
  • Title: Do Not Contact Reason
    The reason code for the contact preference.
  • Title: Email
    Maximum Length: 255
    The email address of the contact point.
  • Title: Email Purpose
    Maximum Length: 30
    The purpose of the email.
  • Title: Object Version Number
    The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
  • Title: Party ID
    The unique identifier of the party.
  • Title: Registry ID
    The party number. Inactive records can't be updated.
  • Title: Party Source System
    The name of external source system of the account, contact or household with which the address is associated. Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.
  • Title: Party Source System Reference Value
    The unique identifier of the relationship from external source system.
  • Title: Area Code
    Maximum Length: 255
    The area code for the telephone number.
  • Title: Phone Country Code
    Maximum Length: 255
    The country code of the phone number.
  • Title: Extension
    Maximum Length: 255
    The extension number of the phone line number like office desk extension.
  • Title: Phone
    Maximum Length: 255
    The phone number of the contact point.
  • Title: Phone Purpose
    Maximum Length: 30
    Defines the purpose of using the PHONE contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.
  • Title: Type
    The type of the phone. A list of valid phone types is defined in the lookup ORA_HZ_PHONE_TYPE. You can review and update the codes using the Setup and Maintenance task, Manage Standard Lookups.
  • Title: Preference Requested By
    Indicates if the permission or restriction was created internally or requested by the party. The list of accepted values are defined in the REQUESTED_BY lookup.
  • Title: Primary
    Maximum Length: 1
    Default Value: false
    Indicates whether the phone number is preferred.
  • Title: Phone
    Maximum Length: 255
    The phone number in raw format.
  • Smart Actions
    Title: Smart Actions
    The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: User ID
    The unique identifier of the social network.
  • Title: Social Network
    The name of the social network.
  • Title: Social Network Purpose
    Maximum Length: 30
    Defines the purpose of using the IM contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.
  • Title: Source System
    The name of external source system, which is defined by an admin as part of system setup. It is part of alternate key (along with SourceSystemReference), and is mandatory if PK or partyNumberBusinessKey is not passed in update.
  • Title: Source System Reference Value
    The unique identifier for the accounts party from the external source system specified in the attribute SourceSystem. It is part of alternate key (along with SourceSystemReference), and is mandatory if PK or partyNumberBusinessKey is not passed in update.
  • Title: Status
    Maximum Length: 30
    Default Value: A
    The status of the contact point.
  • Title: URL
    The URL associated with the contact point.
  • Title: Verification Date
    The date of verification of the phone or email contact point.
  • Title: Verification Status
    Maximum Length: 30
    The status of the verification for phone or email contact points. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID, ORA_INVALID and ORA_PARTIALLY_VALID. The value ORA_PARTIALLY_VALID is applicable only for email. Default value is blank which indicates that values aren't verified.
  • Title: Web Purpose
    Maximum Length: 30
    Defines the purpose of using the WEB contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE_WEB.Sample values: HOMEPAGE,SALESURL,MARKETINGURL,SUPPORTURL,RSS_FEED etc.
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : accounts-ContactPoint-smartActions-item-patch-request
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : accounts-ContactPoint-smartActions-UserActionNavigation-item-patch-request
Type: object
Show Source
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Application Usage
    Maximum Length: 50
    The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
  • Title: Navigation Metadata
    Maximum Length: 1000
    The metadata definition of the smart action user interface endpoint.
  • Title: Navigation Type
    Maximum Length: 100
    The text value used by applications to determine which user interface to launch.
Nested Schema : accounts-ContactPoint-smartActions-UserActionRequestPayload-item-patch-request
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
  • Title: Mandatory
    Maximum Length: 1
    Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
  • Title: Payload Value Structure
    Maximum Length: 20
    A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : accounts-ContactPoint-smartActions-UserActionURLBinding-item-patch-request
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : accounts-ContactPoint-item-response
Type: object
Show Source
  • Title: Conflict ID
    Default Value: 0
    The unique identifier of the conflict.
  • Title: Contact Point ID
    Read Only: true
    The unique identifier of the contact point.
  • Title: Type
    Maximum Length: 30
    The type of contact point. A list of valid contact point types is defined in the lookup COMMUNICATION_TYPE. You can review and update the codes using the Setup and Maintenance task, Manage Contact Point Lookups.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Title: Created by Application
    Default Value: HZ_WS
    The user who created the module.
  • Title: Creation Date
    Read Only: true
    The date when the record was created.
  • Title: OK to Contact
    Indicates whether to use a particular contact method. Defaulted to false.
  • Title: Do Not Contact
    The contact preference flag that indicates DNC option.
  • Title: Do Not Contact Reason
    The reason code for the contact preference.
  • Title: Email
    Maximum Length: 255
    The email address of the contact point.
  • Title: Email Purpose
    Maximum Length: 30
    The purpose of the email.
  • Title: Phone Number
    Read Only: true
    Maximum Length: 255
    The formatted phone number of the contact point.
  • Title: Last Update Date
    Read Only: true
    The date when the contact point was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the contact point.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the contact point.
  • Links
  • Title: Object Version Number
    The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
  • Title: Party ID
    The unique identifier of the party.
  • Title: Registry ID
    The party number. Inactive records can't be updated.
  • Title: Party Source System
    The name of external source system of the account, contact or household with which the address is associated. Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.
  • Title: Party Source System Reference Value
    The unique identifier of the relationship from external source system.
  • Title: Area Code
    Maximum Length: 255
    The area code for the telephone number.
  • Title: Phone Country Code
    Maximum Length: 255
    The country code of the phone number.
  • Title: Extension
    Maximum Length: 255
    The extension number of the phone line number like office desk extension.
  • Title: Phone
    Maximum Length: 255
    The phone number of the contact point.
  • Title: Phone Purpose
    Maximum Length: 30
    Defines the purpose of using the PHONE contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.
  • Title: Type
    The type of the phone. A list of valid phone types is defined in the lookup ORA_HZ_PHONE_TYPE. You can review and update the codes using the Setup and Maintenance task, Manage Standard Lookups.
  • Title: Preference Requested By
    Indicates if the permission or restriction was created internally or requested by the party. The list of accepted values are defined in the REQUESTED_BY lookup.
  • Title: Primary
    Maximum Length: 1
    Default Value: false
    Indicates whether the phone number is preferred.
  • Title: Phone
    Maximum Length: 255
    The phone number in raw format.
  • Smart Actions
    Title: Smart Actions
    The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: User ID
    The unique identifier of the social network.
  • Title: Social Network
    The name of the social network.
  • Title: Social Network Purpose
    Maximum Length: 30
    Defines the purpose of using the IM contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.
  • Title: Source System
    The name of external source system, which is defined by an admin as part of system setup. It is part of alternate key (along with SourceSystemReference), and is mandatory if PK or partyNumberBusinessKey is not passed in update.
  • Title: Source System Reference Value
    The unique identifier for the accounts party from the external source system specified in the attribute SourceSystem. It is part of alternate key (along with SourceSystemReference), and is mandatory if PK or partyNumberBusinessKey is not passed in update.
  • Title: Status
    Maximum Length: 30
    Default Value: A
    The status of the contact point.
  • Title: URL
    The URL associated with the contact point.
  • Title: Verification Date
    The date of verification of the phone or email contact point.
  • Title: Verification Status
    Maximum Length: 30
    The status of the verification for phone or email contact points. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID, ORA_INVALID and ORA_PARTIALLY_VALID. The value ORA_PARTIALLY_VALID is applicable only for email. Default value is blank which indicates that values aren't verified.
  • Title: Web Purpose
    Maximum Length: 30
    Defines the purpose of using the WEB contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE_WEB.Sample values: HOMEPAGE,SALESURL,MARKETINGURL,SUPPORTURL,RSS_FEED etc.
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : accounts-ContactPoint-smartActions-item-response
Type: object
Show Source
  • Title: Action Intent
    JSON object that describes what an action does and what context data can be passed to the action.
  • Title: Confirmation Message
    Maximum Length: 4000
    The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
  • Title: Content Type
    Maximum Length: 50
    The media type of the smart action REST operation.
  • Title: Action Name
    Maximum Length: 256
    The display name of the smart action.
  • Title: Parent Entity
    Maximum Length: 150
    The primary object the smart action is associated with. For example, if the smart action creates an appointment for a lead, lead is the primary object.
  • Title: REST Endpoint
    Maximum Length: 1024
    The relative path of the smart action REST resource. The path can include path parameters.
  • Title: Included in Application
    Maximum Length: 512
    The client applications that the smart action is associated with.
  • Links
  • Title: Mass Action
    Maximum Length: 1
    Boolean type indicating if this action can be mass processed.
  • Title: HTTP Method
    Maximum Length: 15
    The HTTP method of the smart action REST operation.
  • Title: Object Function
    Maximum Length: 64
    The object function associated with the smart action.
  • Title: Page Type
    Maximum Length: 256
    The list of pages that this action can be used in.
  • Title: Smart Suggest
    Maximum Length: 1
    Indicates whether smart suggest is enabled for the action.
  • Title: System Action
    Maximum Length: 1
    Indicates whether the action is seeded or custom.
  • Title: Attributes to Update
    Maximum Length: 512
    The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
  • Title: User Action ID
    The unique system assigned identifier of the smart action definition.
  • Title: Action Name
    Maximum Length: 256
    The unique system assigned smart action name.
  • Smart Action User Interface Definitions
    Title: Smart Action User Interface Definitions
    The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Priority
    The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
  • Smart Action REST Payload Definitions
    Title: Smart Action REST Payload Definitions
    The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Smart Action REST Path Parameter Definitions
    Title: Smart Action REST Path Parameter Definitions
    The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Path Parameter Definitions
Type: array
Title: Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : accounts-ContactPoint-smartActions-UserActionNavigation-item-response
Type: object
Show Source
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Application Usage
    Maximum Length: 50
    The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
  • Title: Navigation Metadata
    Maximum Length: 1000
    The metadata definition of the smart action user interface endpoint.
  • Title: Primary Key
    The unique system assigned identifier of a smart action user interface definition.
  • Title: Navigation Type
    Maximum Length: 100
    The text value used by applications to determine which user interface to launch.
Nested Schema : accounts-ContactPoint-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
  • Links
  • Title: Mandatory
    Maximum Length: 1
    Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
  • The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
  • Title: Payload Value Structure
    Maximum Length: 20
    A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : accounts-ContactPoint-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
Links
ContactPointPurposeWebLookupVA
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DCONTACT_POINT_PURPOSE_WEB%2CLookupCode%3D{WebPurpose}
The following properties are defined on the LOV link relation:
  • Source Attribute: WebPurpose; Target Attribute: LookupCode
  • Display Attribute: Meaning
ContactPointTypeLimitedLookUpVO
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DCOMMUNICATION_TYPE%2CLookupCode%3D{ContactPointType}
The following properties are defined on the LOV link relation:
  • Source Attribute: ContactPointType; Target Attribute: LookupCode
  • Display Attribute: Meaning
EmailPurposeLookupVA
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DCONTACT_POINT_PURPOSE%2CLookupCode%3D{EmailPurpose}
The following properties are defined on the LOV link relation:
  • Source Attribute: EmailPurpose; Target Attribute: LookupCode
  • Display Attribute: Meaning
InstantMessengerTypeVOVA
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DHZ_INSTANT_MESSENGER_TYPE%2CLookupCode%3D{SocialNetworkName}
The following properties are defined on the LOV link relation:
  • Source Attribute: SocialNetworkName; Target Attribute: LookupCode
  • Display Attribute: LookupCode
PhonePurposeLookupVA
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DCONTACT_POINT_PURPOSE%2CLookupCode%3D{PhonePurpose}
The following properties are defined on the LOV link relation:
  • Source Attribute: PhonePurpose; Target Attribute: LookupCode
  • Display Attribute: Meaning
PhoneTypeLookupVA
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DORA_HZ_PHONE_TYPE%2CLookupCode%3D{PhoneType}
The following properties are defined on the LOV link relation:
  • Source Attribute: PhoneType; Target Attribute: LookupCode
  • Display Attribute: Meaning
PreferenceRequestedByLookupVA
Parameters:
  • finder: LookupTypeFinder%3BLookupCode%3D{PreferenceRequestedBy}%2CLookupType%3DREQUESTED_BY
The following properties are defined on the LOV link relation:
  • Source Attribute: PreferenceRequestedBy; Target Attribute: LookupCode
  • Display Attribute: Meaning
ReasonCodesVA
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DREASON_CODE%2CLookupCode%3D{DoNotContactReason}
The following properties are defined on the LOV link relation:
  • Source Attribute: DoNotContactReason; Target Attribute: LookupCode
  • Display Attribute: Meaning
SocialNetworkPurposeLookupVA
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DCONTACT_POINT_PURPOSE%2CLookupCode%3D{SocialNetworkPurpose}
The following properties are defined on the LOV link relation:
  • Source Attribute: SocialNetworkPurpose; Target Attribute: LookupCode
  • Display Attribute: Meaning
VerificationStatusLookupVA
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DORA_HZ_VALIDATION_STATUS%2CLookupCode%3D{VerificationStatus}
The following properties are defined on the LOV link relation:
  • Source Attribute: VerificationStatus; Target Attribute: LookupCode
  • Display Attribute: Meaning
smartActions
Parameters:
  • ContactPointId: $request.path.ContactPointId
  • PartyNumber: $request.path.PartyNumber
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Back to Top

Examples

The following example shows how to update a contact point by submitting a PATCH request on the REST resource using cURL.

cURL Command

curl --user sales_cloud_user -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/CDRM_896782/child/ContactPoint/300100186868996

Request Body

The following shows the contents of the request body in JSON format.

{
"PhoneNumber": "8876459041"
}

Response Body

The following shows the contents of the response body in JSON format.

{
    "ContactPointId": 300100186868996,
    "ContactPointType": "PHONE",
    "PartyId": 300100186870447,
    "PartyNumber": "CDRM_896782",
    "PartySourceSystem": null,
    "PartySourceSystemReferenceValue": null,
    "EmailAddress": null,
    "EmailPurpose": null,
    "PhoneType": "LAND",
    "PhoneAreaCode": null,
    "PhoneExtension": null,
    "PhoneCountryCode": "1",
    "RawPhoneNumber": "1-9785637285",
    "PhoneNumber": "8876459041",
    "FormattedPhoneNumber": "+1 (887) 645-9041",
    "URL": null,
    "PrimaryFlag": true,
    "Status": "A",
    "SourceSystem": null,
    "SourceSystemReferenceValue": null,
    "CreatedBy": "SALES_ADMIN",
    "CreatedByModule": "HZ_WS",
    "CreationDate": "2021-03-04T04:33:24.010+00:00",
    "LastUpdateDate": "2021-03-04T04:35:37+00:00",
    "LastUpdateLogin": "BCAA68A33934AA90E0533BFDF40AC236",
    "LastUpdatedBy": "SALES_ADMIN",
    "ObjectVersionNumber": 2,
    "DoContactPreferenceFlag": false,
    "DoNotContactPreferenceFlag": false,
    "DoNotContactReason": null,
    "ConflictId": 0,
    "SocialNetworkName": null,
    "SocialNetworkId": null,
    "PhonePurpose": null,
    "WebPurpose": null,
    "SocialNetworkPurpose": null,
    "links": [
...
}
Back to Top