Create a contact point
post
/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/ContactPoint
Request
Path Parameters
-
PartyNumber(required): string
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.
Header Parameters
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
-
Upsert-Mode:
When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.
Supported Media Types
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : schema
Type:
Show Source
object
-
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. -
ContactPointType: string
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. -
CreatedByModule: string
Title:
Created by Application
Default Value:HZ_WS
The user who created the module. -
DoContactPreferenceFlag: boolean
Title:
OK to Contact
Indicates whether to use a particular contact method. Defaulted to false. -
DoNotContactPreferenceFlag: boolean
The contact preference flag that indicates DNC option.
-
DoNotContactReason: string
The reason code for the contact preference.
-
EmailAddress: string
Maximum Length:
255
The email address of the contact point. -
EmailPurpose: string
Title:
Email Purpose
Maximum Length:30
The purpose of the email. -
ObjectVersionNumber: integer
(int32)
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.
-
PartyId: integer
(int64)
The unique identifier of the party.
-
PartyNumber: string
The party number.
-
PartySourceSystem: string
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.
-
PartySourceSystemReferenceValue: string
The unique identifier of the relationship from external source system.
-
PhoneAreaCode: string
Maximum Length:
255
The area code for the telephone number. -
PhoneCountryCode: string
Maximum Length:
255
The country code of the phone number. -
PhoneExtension: string
Maximum Length:
255
The extension number of the phone line number like office desk extension. -
PhoneNumber: string
Maximum Length:
255
The phone number of the contact point. -
PhonePurpose: string
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. -
PhoneType: string
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.
-
PreferenceRequestedBy: string
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. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates whether the phone number is preferred. -
RawPhoneNumber: string
Maximum Length:
255
The phone number in raw format. -
SocialNetworkId: string
The unique identifier of the social network.
-
SocialNetworkName: string
The name of the social network.
-
SocialNetworkPurpose: string
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. -
SourceSystem: string
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.
-
SourceSystemReferenceValue: string
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.
-
Status: string
Maximum Length:
30
Default Value:A
The status of the contact point. -
URL: string
The URL associated with the contact point.
-
VerificationDate: string
(date)
Title:
Verification Date
The date of verification of the phone or email contact point. -
VerificationStatus: string
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. -
WebPurpose: string
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.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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".
-
REST-Framework-Version(required):
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.
Root Schema : accounts-ContactPoint-item-response
Type:
Show Source
object
-
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. -
ContactPointId: integer
(int64)
Read Only:
true
The unique identifier of the contact point. -
ContactPointType: string
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. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreatedByModule: string
Title:
Created by Application
Default Value:HZ_WS
The user who created the module. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
DoContactPreferenceFlag: boolean
Title:
OK to Contact
Indicates whether to use a particular contact method. Defaulted to false. -
DoNotContactPreferenceFlag: boolean
The contact preference flag that indicates DNC option.
-
DoNotContactReason: string
The reason code for the contact preference.
-
EmailAddress: string
Maximum Length:
255
The email address of the contact point. -
EmailPurpose: string
Title:
Email Purpose
Maximum Length:30
The purpose of the email. -
FormattedPhoneNumber: string
Read Only:
true
Maximum Length:255
The formatted phone number of the contact point. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the contact point was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the contact point. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the contact point. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
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.
-
PartyId: integer
(int64)
The unique identifier of the party.
-
PartyNumber: string
The party number.
-
PartySourceSystem: string
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.
-
PartySourceSystemReferenceValue: string
The unique identifier of the relationship from external source system.
-
PhoneAreaCode: string
Maximum Length:
255
The area code for the telephone number. -
PhoneCountryCode: string
Maximum Length:
255
The country code of the phone number. -
PhoneExtension: string
Maximum Length:
255
The extension number of the phone line number like office desk extension. -
PhoneNumber: string
Maximum Length:
255
The phone number of the contact point. -
PhonePurpose: string
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. -
PhoneType: string
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.
-
PreferenceRequestedBy: string
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. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates whether the phone number is preferred. -
RawPhoneNumber: string
Maximum Length:
255
The phone number in raw format. -
SocialNetworkId: string
The unique identifier of the social network.
-
SocialNetworkName: string
The name of the social network.
-
SocialNetworkPurpose: string
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. -
SourceSystem: string
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.
-
SourceSystemReferenceValue: string
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.
-
Status: string
Maximum Length:
30
Default Value:A
The status of the contact point. -
URL: string
The URL associated with the contact point.
-
VerificationDate: string
(date)
Title:
Verification Date
The date of verification of the phone or email contact point. -
VerificationStatus: string
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. -
WebPurpose: string
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
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
- finder:
- 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
- finder:
- 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
- finder:
- 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
- finder:
- 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
- finder:
- 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
- finder:
- 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
- finder:
- 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
- finder:
- 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
- finder:
- 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
- finder: