Update a linked party
patch
/crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/DuplicateParty/{PartyNumber2}
Request
Path Parameters
-
PartyNumber(required): string
The unique alternate identifier for the organization 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.
-
PartyNumber2(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=
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
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 : hubOrganizations-DuplicateParty-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the duplicate party. -
CreationDate: string
(date-time)
Read Only:
true
The date when the duplicate party was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the duplicate party was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the duplicate party. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the duplicate party. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
The unique identifier of the party associated to the duplicate party.
-
PartyName: string
Read Only:
true
Maximum Length:360
The party name of the duplicate party. -
PartyNumber: string
Maximum Length:
30
The party number of the duplicate party. -
PromotedFlag: boolean
Read Only:
true
Maximum Length:1
Indicates if the party in the duplicate set is the promoted account.
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.