Update a contact member
patch
/crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/contacts/{MemberId}
Request
Path Parameters
-
MemberId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
SrId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AccessLevelCd: string
Title:
Access Level
Maximum Length:30
The access level granted to the service request contact. -
ContactPartyName: string
Title:
Name
Maximum Length:360
The name of a service request contact. -
ContactTypeCd: string
Title:
Contact Type
Maximum Length:30
The service request contact type such as Customer or Partner. -
ContactUniqueName: string
Title:
Unique Name
Maximum Length:900
The unique party name of the contact. -
MemberId: integer
(int64)
Title:
Member ID
The unique identifier of the contact. -
PartyId: integer
(int64)
Title:
Party ID
The unique party identifier of the contact. -
PersonId: integer
(int64)
Title:
Person ID
The unique person ID of the contact. -
PrimaryContactFlag: boolean
Title:
Primary
Indicates whether the contact is the primary contact for the service request. If yes, the value is True, else the value is False. -
RelationTypeCd: string
Title:
Relationship Type Code
Maximum Length:30
The relationship with the contact in context of the service request. For example, Alternate, Follower, Third_Party, and so on.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : internalServiceRequests-contacts-item-response
Type:
Show Source
object
-
AccessLevelCd: string
Title:
Access Level
Maximum Length:30
The access level granted to the service request contact. -
AccountName: string
Title:
Account Name
Read Only:true
Maximum Length:900
The primary account of the service request contact. -
ContactEmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The email address of the contact. -
ContactFormattedPhoneNumber: string
Title:
Phone
Read Only:true
The formatted phone number of the contact. -
ContactPartyName: string
Title:
Name
Maximum Length:360
The name of a service request contact. -
ContactPartyNumber: string
Title:
Contact Number
Read Only:true
Maximum Length:30
The alternative key for the contact identifier. -
ContactPreferredContactMethod: string
Title:
Preferred Contact Method
Read Only:true
Maximum Length:30
The preferred contact method of the contact. -
ContactTypeCd: string
Title:
Contact Type
Maximum Length:30
The service request contact type such as Customer or Partner. -
ContactUniqueName: string
Title:
Unique Name
Maximum Length:900
The unique party name of the contact. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who added the contact as a member of the service request. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
DeleteFlag: boolean
Title:
Can Delete
Read Only:true
Indicates whether the user has access to delete the record. -
DoNotContactFlag: boolean
Title:
Do Not Contact
Read Only:true
Maximum Length:1
Indicates whether the contact of the service request doesn't want to be contacted. -
FormattedAddress: string
Title:
Formatted Address
Read Only:true
Indicates the formatted address of the service request contact. -
JobTitle: string
Title:
Job Title
Read Only:true
Maximum Length:100
The job title of the service request contact. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the service request contact member record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last update the contact's object associated with the service request. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MemberId: integer
(int64)
Title:
Member ID
The unique identifier of the contact. -
PartyId: integer
(int64)
Title:
Party ID
The unique party identifier of the contact. -
PersonId: integer
(int64)
Title:
Person ID
The unique person ID of the contact. -
PrimaryContactFlag: boolean
Title:
Primary
Indicates whether the contact is the primary contact for the service request. If yes, the value is True, else the value is False. -
RelationTypeCd: string
Title:
Relationship Type Code
Maximum Length:30
The relationship with the contact in context of the service request. For example, Alternate, Follower, Third_Party, and so on. -
SrId: integer
(int64)
Title:
Service Request ID
The unique identifier of the associated service request. -
SrNumber: string
Title:
Service Request Number
Maximum Length:30
The alternative key for the service request number. -
UpdateFlag: boolean
Title:
Can Update
Read Only:true
Indicates whether the user has access to update the record.
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
- AccessLevelLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_SR_ACCESS_LEVEL
The following properties are defined on the LOV link relation:- Source Attribute: AccessLevelCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ContactTypeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_SR_CONTACT_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: ContactTypeCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- PersonDVO
-
Operation: /crmRestApi/resources/11.13.18.05/contactsThe following properties are defined on the LOV link relation:
- Source Attribute: ContactPartyName; Target Attribute: PartyName
- Display Attribute: PartyName, PrimaryEmailAddress
- RelationshipTypeLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_CONTACT_REL_TYPE_CD
The following properties are defined on the LOV link relation:- Source Attribute: RelationTypeCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: