Update a territory coverage
patch
/crmRestApi/resources/11.13.18.05/salesTerritories/{UniqueTerritoryNumber}/child/TerritoryCoverage/{CoverageNumber}
Request
Path Parameters
-
CoverageNumber(required): string
The public unique identifier of the territory coverage rule.
-
UniqueTerritoryNumber(required): string
The unique identification number for the territory.
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
-
AccountId: integer
(int64)
Title:
Account ID
The identifier for the customer inclusion or exclusion. -
AccountTypeCode: string
Title:
Account Type Code
Maximum Length:30
The code for the account type in the territory coverage. -
AddressCity: string
Title:
City
Maximum Length:60
The city of the address dimension in the territory coverage. -
AddressCountry: string
Title:
Country
Maximum Length:2
The country of the address dimension in the territory coverage. -
AddressCounty: string
Title:
County
Maximum Length:60
The county of the address dimension in the territory coverage. -
AddressElementAttribute1: string
Title:
Additional Attribute 1
Maximum Length:150
The additional attribute 1 of the address dimension in the territory coverage. -
AddressElementAttribute2: string
Title:
Additional Attribute 2
Maximum Length:150
The additional attribute 2 of the address dimension in the territory coverage. -
AddressElementAttribute3: string
Title:
Additional Attribute 3
Maximum Length:150
The additional attribute 3 of the address dimension in the territory coverage. -
AddressElementAttribute4: string
Title:
Additional Attribute 4
Maximum Length:150
The additional attribute 4 of the address dimension in the territory coverage. -
AddressElementAttribute5: string
Title:
Additional Attribute 5
Maximum Length:150
The additional attribute 5 of the address dimension in the territory coverage. -
AddressPostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the address dimension in the territory coverage. -
AddressProvince: string
Title:
Province
Maximum Length:60
The province of the address dimension in the territory coverage. -
AddressState: string
Title:
State
Maximum Length:60
The state of the address dimension in the territory coverage. -
Auxiliary1Code: string
Title:
Auxiliary 1 Code
Maximum Length:30
The auxiliary 1 code in the territory coverage. -
Auxiliary2Code: string
Title:
Auxiliary 2 Code
Maximum Length:30
The auxiliary 2 code in the territory coverage. -
Auxiliary3Code: string
Title:
Auxiliary 3 Code
Maximum Length:30
The auxiliary 3 code in the territory coverage. -
BusinessUnitId: integer
(int64)
Title:
Business Unit ID
The identifier for the business unit in the territory coverage. -
BusinessUnitName: string
Title:
Business Unit
Maximum Length:255
The name for the business unit in the territory coverage. -
CoverageTypeCode: string
Title:
Coverage Type Code
Maximum Length:30
The code for the territory coverage type. If the territory coverage model is sales account centric, the accepted values are: -REGULAR (for coverage based on sales account dimensionality or named accounts) -INCLUSION (for manually included account coverage) -EXCLUSION (for manually excluded account coverage) If the territory coverage model is partner centric, the accepted values are: -PARTNER_REGULAR (for coverage based on partner dimensionality) -PARTNER_INCLUSION (for manually included partner coverage) -PARTNER_EXCLUSION (for manually excluded partner coverage) In case of inheritance, if the coverage is for a recipient territory, then the accepted value is INHERITANCE_OVERRIDE which indicates that the coverage overrides some of the inherited dimensionality. -
CustomerSizeCode: string
Title:
Customer Size Code
Maximum Length:30
The code for the customer size in the territory coverage. -
Extension10Code: string
Title:
Extension 10 Code
Maximum Length:30
The extension 10 code in the territory coverage. -
Extension1Code: string
Title:
Extension 1 Code
Maximum Length:30
The extension 1 code in the territory coverage. -
Extension2Code: string
Title:
Extension 2 Code
Maximum Length:30
The extension 2 code in the territory coverage. -
Extension3Code: string
Title:
Extension 3 Code
Maximum Length:30
The extension 3 code in the territory coverage. -
Extension4Code: string
Title:
Extension 4 Code
Maximum Length:30
The extension 4 code in the territory coverage. -
Extension5Code: string
Title:
Extension 5 Code
Maximum Length:30
The extension 5 code in the territory coverage. -
Extension6Code: string
Title:
Extension 6 Code
Maximum Length:30
The extension 6 code in the territory coverage. -
Extension7Code: string
Title:
Extension 7 Code
Maximum Length:30
The extension 7 code in the territory coverage. -
Extension8Code: string
Title:
Extension 8 Code
Maximum Length:30
The extension 8 code in the territory coverage. -
Extension9Code: string
Title:
Extension 9 Code
Maximum Length:30
The extension 9 code in the territory coverage. -
GeographyHighId: integer
(int64)
Title:
Geography High ID
The identifier for the higher geography in the range in the territory coverage. -
GeographyHighName: string
Title:
Geography High Name
The name for the higher geography in the range in the territory coverage. -
GeographyId: integer
(int64)
Title:
Geography ID
The identifier for the geography in the territory coverage. -
GeographyName: string
Title:
Geography
The name of the geography in the territory coverage. This may include the full path of the geography in order to uniquely identify the location, for example; >United States>New Hampshire>Manchester. -
IncludeHierarchyFlag: boolean
Title:
Include Hierarchy
Maximum Length:1
Indicates whether the dimension member is included along with its hierarchy or not. The default value is true. -
IndustryCode: string
Title:
Industry Code
Maximum Length:30
The code for the industry in the territory coverage. -
InventoryItemId: integer
(int64)
Title:
Inventory Item ID
The identifier for the inventory item in the territory coverage. -
InventoryOrgId: integer
(int64)
Title:
Inventory Organization ID
The identifier for the inventory organization in the territory coverage. -
OrganizationTypeCode: string
Title:
Organization Type Code
Maximum Length:30
The code for the organization type in the territory coverage. -
OriginalReference: string
Title:
Original Reference
Maximum Length:300
The origin source system reference of the account or contact. -
PartnerId: integer
(int64)
Title:
Partner ID
The identifier of the partner inclusion or exclusion. -
ProductGroupId: integer
(int64)
Title:
Product Group ID
The identifier for the product group in the territory coverage. -
ProductGroupNumber: string
Title:
Product Group Number
Maximum Length:50
The number for the product group in the territory coverage. -
SalesChannelCode: string
Title:
Sales Channel Code
Maximum Length:30
The code for the sales channel in the territory coverage. -
SubSalesChannelCode: string
Title:
Subsales Channel Code
Maximum Length:30
The code for the sub sales channel in the territory coverage. -
TerrDimensionCode: string
Title:
Territory Dimension Code
Maximum Length:5
The code indicating the territory dimension. For example, AcTyp, Acct, Aux1, Aux2, Aux3, BUnit, CSize, Geo, Indst, OrgTp, Prod, Prtnr, or SChnl.
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 : salesTerritories-TerritoryCoverage-item-response
Type:
Show Source
object
-
AccountId: integer
(int64)
Title:
Account ID
The identifier for the customer inclusion or exclusion. -
AccountName: string
Title:
Customer Account
Read Only:true
Maximum Length:360
The name of the customer inclusion. -
AccountTypeCode: string
Title:
Account Type Code
Maximum Length:30
The code for the account type in the territory coverage. -
AddressCity: string
Title:
City
Maximum Length:60
The city of the address dimension in the territory coverage. -
AddressCountry: string
Title:
Country
Maximum Length:2
The country of the address dimension in the territory coverage. -
AddressCounty: string
Title:
County
Maximum Length:60
The county of the address dimension in the territory coverage. -
AddressElementAttribute1: string
Title:
Additional Attribute 1
Maximum Length:150
The additional attribute 1 of the address dimension in the territory coverage. -
AddressElementAttribute2: string
Title:
Additional Attribute 2
Maximum Length:150
The additional attribute 2 of the address dimension in the territory coverage. -
AddressElementAttribute3: string
Title:
Additional Attribute 3
Maximum Length:150
The additional attribute 3 of the address dimension in the territory coverage. -
AddressElementAttribute4: string
Title:
Additional Attribute 4
Maximum Length:150
The additional attribute 4 of the address dimension in the territory coverage. -
AddressElementAttribute5: string
Title:
Additional Attribute 5
Maximum Length:150
The additional attribute 5 of the address dimension in the territory coverage. -
AddressPostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the address dimension in the territory coverage. -
AddressProvince: string
Title:
Province
Maximum Length:60
The province of the address dimension in the territory coverage. -
AddressState: string
Title:
State
Maximum Length:60
The state of the address dimension in the territory coverage. -
Auxiliary1Code: string
Title:
Auxiliary 1 Code
Maximum Length:30
The auxiliary 1 code in the territory coverage. -
Auxiliary2Code: string
Title:
Auxiliary 2 Code
Maximum Length:30
The auxiliary 2 code in the territory coverage. -
Auxiliary3Code: string
Title:
Auxiliary 3 Code
Maximum Length:30
The auxiliary 3 code in the territory coverage. -
AuxiliaryDimension1: string
Title:
Auxiliary 1
Read Only:true
The auxiliary 1 name in the territory coverage. -
AuxiliaryDimension2: string
Title:
Auxiliary 2
Read Only:true
The auxiliary 2 name in the territory coverage. -
AuxiliaryDimension3: string
Title:
Auxiliary 3
Read Only:true
The auxiliary 3 name in the territory coverage. -
BusinessUnitId: integer
(int64)
Title:
Business Unit ID
The identifier for the business unit in the territory coverage. -
BusinessUnitName: string
Title:
Business Unit
Maximum Length:255
The name for the business unit in the territory coverage. -
CoverageId: integer
(int64)
Title:
Coverage ID
The unique identifier of the territory coverage rule. -
CoverageNumber: string
Title:
Coverage Number
Maximum Length:30
The public unique identifier of the territory coverage rule. -
CoverageTypeCode: string
Title:
Coverage Type Code
Maximum Length:30
The code for the territory coverage type. If the territory coverage model is sales account centric, the accepted values are: -REGULAR (for coverage based on sales account dimensionality or named accounts) -INCLUSION (for manually included account coverage) -EXCLUSION (for manually excluded account coverage) If the territory coverage model is partner centric, the accepted values are: -PARTNER_REGULAR (for coverage based on partner dimensionality) -PARTNER_INCLUSION (for manually included partner coverage) -PARTNER_EXCLUSION (for manually excluded partner coverage) In case of inheritance, if the coverage is for a recipient territory, then the accepted value is INHERITANCE_OVERRIDE which indicates that the coverage overrides some of the inherited dimensionality. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the territory coverage. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the territory coverage was created. -
CustomerSizeCode: string
Title:
Customer Size Code
Maximum Length:30
The code for the customer size in the territory coverage. -
DimensionName: string
Title:
Dimension Name
Read Only:true
Maximum Length:60
The name of a dimension used in sales territories to define the area of responsibility for the salesperson. Examples are the Product and Industry dimensions. -
Extension1: string
Title:
Extension 1
Read Only:true
Maximum Length:255
The extension 1 name in the territory coverage. -
Extension10: string
Title:
Extension 10
Read Only:true
Maximum Length:255
The extension 10 name in the territory coverage. -
Extension10Code: string
Title:
Extension 10 Code
Maximum Length:30
The extension 10 code in the territory coverage. -
Extension1Code: string
Title:
Extension 1 Code
Maximum Length:30
The extension 1 code in the territory coverage. -
Extension2: string
Title:
Extension 2
Read Only:true
Maximum Length:255
The extension 2 name in the territory coverage. -
Extension2Code: string
Title:
Extension 2 Code
Maximum Length:30
The extension 2 code in the territory coverage. -
Extension3: string
Title:
Extension 3
Read Only:true
Maximum Length:255
The extension 3 name in the territory coverage. -
Extension3Code: string
Title:
Extension 3 Code
Maximum Length:30
The extension 3 code in the territory coverage. -
Extension4: string
Title:
Extension 4
Read Only:true
Maximum Length:255
The extension 4 name in the territory coverage. -
Extension4Code: string
Title:
Extension 4 Code
Maximum Length:30
The extension 4 code in the territory coverage. -
Extension5: string
Title:
Extension 5
Read Only:true
Maximum Length:255
The extension 5 name in the territory coverage. -
Extension5Code: string
Title:
Extension 5 Code
Maximum Length:30
The extension 5 code in the territory coverage. -
Extension6: string
Title:
Extension 6
Read Only:true
Maximum Length:255
The extension 6 name in the territory coverage. -
Extension6Code: string
Title:
Extension 6 Code
Maximum Length:30
The extension 6 code in the territory coverage. -
Extension7: string
Title:
Extension 7
Read Only:true
Maximum Length:255
The extension 7 name in the territory coverage. -
Extension7Code: string
Title:
Extension 7 Code
Maximum Length:30
The extension 7 code in the territory coverage. -
Extension8: string
Title:
Extension 8
Read Only:true
Maximum Length:255
The extension 8 name in the territory coverage. -
Extension8Code: string
Title:
Extension 8 Code
Maximum Length:30
The extension 8 code in the territory coverage. -
Extension9: string
Title:
Extension 9
Read Only:true
Maximum Length:255
The extension 9 name in the territory coverage. -
Extension9Code: string
Title:
Extension 9 Code
Maximum Length:30
The extension 9 code in the territory coverage. -
GeographyHighId: integer
(int64)
Title:
Geography High ID
The identifier for the higher geography in the range in the territory coverage. -
GeographyHighName: string
Title:
Geography High Name
The name for the higher geography in the range in the territory coverage. -
GeographyId: integer
(int64)
Title:
Geography ID
The identifier for the geography in the territory coverage. -
GeographyName: string
Title:
Geography
The name of the geography in the territory coverage. This may include the full path of the geography in order to uniquely identify the location, for example; >United States>New Hampshire>Manchester. -
IncludeHierarchyFlag: boolean
Title:
Include Hierarchy
Maximum Length:1
Indicates whether the dimension member is included along with its hierarchy or not. The default value is true. -
IndustryCode: string
Title:
Industry Code
Maximum Length:30
The code for the industry in the territory coverage. -
IndustryName: string
Title:
Industry
Read Only:true
The name of the industry in the territory coverage. -
InventoryItemId: integer
(int64)
Title:
Inventory Item ID
The identifier for the inventory item in the territory coverage. -
InventoryOrgId: integer
(int64)
Title:
Inventory Organization ID
The identifier for the inventory organization in the territory coverage. -
ItemName: string
Title:
Item Name
Read Only:true
Maximum Length:240
The name for the item in the territory coverage. -
ItemNumber: string
Title:
Item Number
Read Only:true
Maximum Length:300
The number for the item in the territory coverage. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date the territory coverage was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the territory coverage. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the territory coverage. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationType: string
Title:
Organization Type
Read Only:true
The name of the organization type in the territory coverage. -
OrganizationTypeCode: string
Title:
Organization Type Code
Maximum Length:30
The code for the organization type in the territory coverage. -
OriginalReference: string
Title:
Original Reference
Maximum Length:300
The origin source system reference of the account or contact. -
PartnerId: integer
(int64)
Title:
Partner ID
The identifier of the partner inclusion or exclusion. -
PartnerName: string
Title:
Partner
Read Only:true
Maximum Length:360
The name of the partner inclusion. -
PartnerNumber: string
Title:
Partner Number
Maximum Length:30
The public unique identifier of the partner inclusion or exclusion. -
ProductGroupId: integer
(int64)
Title:
Product Group ID
The identifier for the product group in the territory coverage. -
ProductGroupName: string
Title:
Product Group Name
Read Only:true
Maximum Length:250
The name for the product group in the territory coverage. -
ProductGroupNumber: string
Title:
Product Group Number
Maximum Length:50
The number for the product group in the territory coverage. -
RegistryId: string
Title:
Registry ID
Read Only:true
Maximum Length:30
The public unique identifier of the customer inclusion. -
SalesChannelCode: string
Title:
Sales Channel Code
Maximum Length:30
The code for the sales channel in the territory coverage. -
SubSalesChannelCode: string
Title:
Subsales Channel Code
Maximum Length:30
The code for the sub sales channel in the territory coverage. -
TerrDimensionCode: string
Title:
Territory Dimension Code
Maximum Length:5
The code indicating the territory dimension. For example, AcTyp, Acct, Aux1, Aux2, Aux3, BUnit, CSize, Geo, Indst, OrgTp, Prod, Prtnr, or SChnl. -
TerritoryVersionId: integer
(int64)
Title:
Territory Version ID
The unique identifier of territory version. -
UniqueTerritoryNumber: string
Title:
Unique Territory Number
Maximum Length:30
The public unique identifier of the territory.
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.