Update a service profile contact
patch
/crmRestApi/resources/11.13.18.05/serviceProfiles/{ServiceProfileNumber}/child/contacts/{SpContactId}
Request
Path Parameters
-
ServiceProfileNumber(required): string
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=
-
SpContactId(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
-
PrimaryContactFlag: boolean
Title:
Primary
Indicates the contact is the primary contact for the service profile.
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 : serviceProfiles-contacts-item-response
Type:
Show Source
object
-
ContactEmailAddress: string
Title:
Contact Email Address
Read Only:true
Maximum Length:320
The email address of the contact belonging to the service profile. -
ContactFormattedPhoneNumber: string
Title:
Phone Number
Read Only:true
The phone number of the contact belonging to the service profile. -
ContactPartyName: string
Title:
Contact Name
Read Only:true
Maximum Length:360
The name of the contact belonging to the service profile. -
ContactPartyNumber: string
Title:
Contact Number
Read Only:true
Maximum Length:30
The PUID of the contact belonging to the service profile. -
ContactPartyUniqueName: string
Title:
Contact Unique Name
Read Only:true
Maximum Length:900
The unique name of the contact belonging to the service profile. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user that created the service profile contact. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the service profile contact was created. -
JobTitle: string
Title:
Job Title
Read Only:true
Maximum Length:100
The job title of the contact belonging to the service profile. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the service profile contact was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the service profile contact. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the service profile contact. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
Title:
Party ID
The contact for the service profile contact. -
PrimaryContactFlag: boolean
Title:
Primary
Indicates the contact is the primary contact for the service profile. -
ServiceProfileId: integer
(int64)
Title:
Service Profile ID
The service profile for the service profile contact. -
ServiceProfileName: string
Title:
Service Profile Name
Read Only:true
Maximum Length:400
The name of the service profile for the service profile contact. -
ServiceProfileNumber: string
Title:
Service Profile Number
Maximum Length:30
The PUID of the service profile for the service profile contact. -
SpContactId: integer
(int64)
Title:
Service Profile Contact ID
Read Only:true
The unique identifier of the service profile contact.
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.