Create a territory coverage
post
/crmRestApi/resources/11.13.18.05/salesTerritories/{UniqueTerritoryNumber}/child/TerritoryCoverage
Request
Path Parameters
-
UniqueTerritoryNumber(required): string
The unique identification number for the territory.
Header Parameters
-
Metadata-Context: string
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: string
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: string
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
AccountId: integer
(int64)
Title:
Account IDThe identifier for the customer inclusion or exclusion. -
AccountTypeCode: string
Title:
Account Type CodeMaximum Length:30The code for the account type in the territory coverage. -
AddressCity: string
Title:
CityMaximum Length:60The city of the address dimension in the territory coverage. -
AddressCountry: string
Title:
CountryMaximum Length:2The country of the address dimension in the territory coverage. -
AddressCounty: string
Title:
CountyMaximum Length:60The county of the address dimension in the territory coverage. -
AddressElementAttribute1: string
Title:
Additional Attribute 1Maximum Length:150The additional attribute 1 of the address dimension in the territory coverage. -
AddressElementAttribute2: string
Title:
Additional Attribute 2Maximum Length:150The additional attribute 2 of the address dimension in the territory coverage. -
AddressElementAttribute3: string
Title:
Additional Attribute 3Maximum Length:150The additional attribute 3 of the address dimension in the territory coverage. -
AddressElementAttribute4: string
Title:
Additional Attribute 4Maximum Length:150The additional attribute 4 of the address dimension in the territory coverage. -
AddressElementAttribute5: string
Title:
Additional Attribute 5Maximum Length:150The additional attribute 5 of the address dimension in the territory coverage. -
AddressPostalCode: string
Title:
Postal CodeMaximum Length:60The postal code of the address dimension in the territory coverage. -
AddressProvince: string
Title:
ProvinceMaximum Length:60The province of the address dimension in the territory coverage. -
AddressState: string
Title:
StateMaximum Length:60The state of the address dimension in the territory coverage. -
Auxiliary1Code: string
Title:
Auxiliary 1 CodeMaximum Length:30The auxiliary 1 code in the territory coverage. -
Auxiliary2Code: string
Title:
Auxiliary 2 CodeMaximum Length:30The auxiliary 2 code in the territory coverage. -
Auxiliary3Code: string
Title:
Auxiliary 3 CodeMaximum Length:30The auxiliary 3 code in the territory coverage. -
BusinessUnitId: integer
(int64)
Title:
Business Unit IDThe identifier for the business unit in the territory coverage. -
BusinessUnitName: string
Title:
Business UnitMaximum Length:255The name for the business unit in the territory coverage. -
CoverageId: integer
(int64)
Title:
Coverage IDThe unique identifier of the territory coverage rule. -
CoverageNumber: string
Title:
Coverage NumberMaximum Length:30The public unique identifier of the territory coverage rule. -
CoverageTypeCode: string
Title:
Coverage Type CodeMaximum Length:30The 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 CodeMaximum Length:30The code for the customer size in the territory coverage. -
Extension10Code: string
Title:
Extension 10 CodeMaximum Length:30The extension 10 code in the territory coverage. -
Extension1Code: string
Title:
Extension 1 CodeMaximum Length:30The extension 1 code in the territory coverage. -
Extension2Code: string
Title:
Extension 2 CodeMaximum Length:30The extension 2 code in the territory coverage. -
Extension3Code: string
Title:
Extension 3 CodeMaximum Length:30The extension 3 code in the territory coverage. -
Extension4Code: string
Title:
Extension 4 CodeMaximum Length:30The extension 4 code in the territory coverage. -
Extension5Code: string
Title:
Extension 5 CodeMaximum Length:30The extension 5 code in the territory coverage. -
Extension6Code: string
Title:
Extension 6 CodeMaximum Length:30The extension 6 code in the territory coverage. -
Extension7Code: string
Title:
Extension 7 CodeMaximum Length:30The extension 7 code in the territory coverage. -
Extension8Code: string
Title:
Extension 8 CodeMaximum Length:30The extension 8 code in the territory coverage. -
Extension9Code: string
Title:
Extension 9 CodeMaximum Length:30The extension 9 code in the territory coverage. -
GeographyHighId: integer
(int64)
Title:
Geography High IDThe identifier for the higher geography in the range in the territory coverage. -
GeographyHighName: string
Title:
Geography High NameThe name for the higher geography in the range in the territory coverage. -
GeographyId: integer
(int64)
Title:
Geography IDThe identifier for the geography in the territory coverage. -
GeographyName: string
Title:
GeographyThe 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 HierarchyMaximum Length:1Indicates whether the dimension member is included along with its hierarchy or not. The default value is true. -
IndustryCode: string
Title:
Industry CodeMaximum Length:30The code for the industry in the territory coverage. -
InventoryItemId: integer
(int64)
Title:
Inventory Item IDThe identifier for the inventory item in the territory coverage. -
InventoryOrgId: integer
(int64)
Title:
Inventory Organization IDThe identifier for the inventory organization in the territory coverage. -
OrganizationTypeCode: string
Title:
Organization Type CodeMaximum Length:30The code for the organization type in the territory coverage. -
OriginalReference: string
Title:
Original ReferenceMaximum Length:300The origin source system reference of the account or contact. -
PartnerId: integer
(int64)
Title:
Partner IDThe identifier of the partner inclusion or exclusion. -
PartnerNumber: string
Title:
Partner NumberMaximum Length:30The public unique identifier of the partner inclusion or exclusion. -
ProductGroupId: integer
(int64)
Title:
Product Group IDThe identifier for the product group in the territory coverage. -
ProductGroupNumber: string
Title:
Product Group NumberMaximum Length:50The number for the product group in the territory coverage. -
SalesChannelCode: string
Title:
Sales Channel CodeMaximum Length:30The code for the sales channel in the territory coverage. -
SubSalesChannelCode: string
Title:
Subsales Channel CodeMaximum Length:30The code for the sub sales channel in the territory coverage. -
TerrDimensionCode: string
Title:
Territory Dimension CodeMaximum Length:5The 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 IDThe unique identifier of territory version. -
UniqueTerritoryNumber: string
Title:
Unique Territory NumberMaximum Length:30The public unique identifier of the territory.
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 IDThe identifier for the customer inclusion or exclusion. -
AccountName: string
Title:
Customer AccountRead Only:trueMaximum Length:360The name of the customer inclusion. -
AccountTypeCode: string
Title:
Account Type CodeMaximum Length:30The code for the account type in the territory coverage. -
AddressCity: string
Title:
CityMaximum Length:60The city of the address dimension in the territory coverage. -
AddressCountry: string
Title:
CountryMaximum Length:2The country of the address dimension in the territory coverage. -
AddressCounty: string
Title:
CountyMaximum Length:60The county of the address dimension in the territory coverage. -
AddressElementAttribute1: string
Title:
Additional Attribute 1Maximum Length:150The additional attribute 1 of the address dimension in the territory coverage. -
AddressElementAttribute2: string
Title:
Additional Attribute 2Maximum Length:150The additional attribute 2 of the address dimension in the territory coverage. -
AddressElementAttribute3: string
Title:
Additional Attribute 3Maximum Length:150The additional attribute 3 of the address dimension in the territory coverage. -
AddressElementAttribute4: string
Title:
Additional Attribute 4Maximum Length:150The additional attribute 4 of the address dimension in the territory coverage. -
AddressElementAttribute5: string
Title:
Additional Attribute 5Maximum Length:150The additional attribute 5 of the address dimension in the territory coverage. -
AddressPostalCode: string
Title:
Postal CodeMaximum Length:60The postal code of the address dimension in the territory coverage. -
AddressProvince: string
Title:
ProvinceMaximum Length:60The province of the address dimension in the territory coverage. -
AddressState: string
Title:
StateMaximum Length:60The state of the address dimension in the territory coverage. -
Auxiliary1Code: string
Title:
Auxiliary 1 CodeMaximum Length:30The auxiliary 1 code in the territory coverage. -
Auxiliary2Code: string
Title:
Auxiliary 2 CodeMaximum Length:30The auxiliary 2 code in the territory coverage. -
Auxiliary3Code: string
Title:
Auxiliary 3 CodeMaximum Length:30The auxiliary 3 code in the territory coverage. -
AuxiliaryDimension1: string
Title:
Auxiliary 1Read Only:trueThe auxiliary 1 name in the territory coverage. -
AuxiliaryDimension2: string
Title:
Auxiliary 2Read Only:trueThe auxiliary 2 name in the territory coverage. -
AuxiliaryDimension3: string
Title:
Auxiliary 3Read Only:trueThe auxiliary 3 name in the territory coverage. -
BusinessUnitId: integer
(int64)
Title:
Business Unit IDThe identifier for the business unit in the territory coverage. -
BusinessUnitName: string
Title:
Business UnitMaximum Length:255The name for the business unit in the territory coverage. -
CoverageId: integer
(int64)
Title:
Coverage IDThe unique identifier of the territory coverage rule. -
CoverageNumber: string
Title:
Coverage NumberMaximum Length:30The public unique identifier of the territory coverage rule. -
CoverageTypeCode: string
Title:
Coverage Type CodeMaximum Length:30The 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 ByRead Only:trueMaximum Length:64The user who created the territory coverage. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the territory coverage was created. -
CustomerSizeCode: string
Title:
Customer Size CodeMaximum Length:30The code for the customer size in the territory coverage. -
DimensionName: string
Title:
Dimension NameRead Only:trueMaximum Length:60The 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 1Read Only:trueMaximum Length:255The extension 1 name in the territory coverage. -
Extension10: string
Title:
Extension 10Read Only:trueMaximum Length:255The extension 10 name in the territory coverage. -
Extension10Code: string
Title:
Extension 10 CodeMaximum Length:30The extension 10 code in the territory coverage. -
Extension1Code: string
Title:
Extension 1 CodeMaximum Length:30The extension 1 code in the territory coverage. -
Extension2: string
Title:
Extension 2Read Only:trueMaximum Length:255The extension 2 name in the territory coverage. -
Extension2Code: string
Title:
Extension 2 CodeMaximum Length:30The extension 2 code in the territory coverage. -
Extension3: string
Title:
Extension 3Read Only:trueMaximum Length:255The extension 3 name in the territory coverage. -
Extension3Code: string
Title:
Extension 3 CodeMaximum Length:30The extension 3 code in the territory coverage. -
Extension4: string
Title:
Extension 4Read Only:trueMaximum Length:255The extension 4 name in the territory coverage. -
Extension4Code: string
Title:
Extension 4 CodeMaximum Length:30The extension 4 code in the territory coverage. -
Extension5: string
Title:
Extension 5Read Only:trueMaximum Length:255The extension 5 name in the territory coverage. -
Extension5Code: string
Title:
Extension 5 CodeMaximum Length:30The extension 5 code in the territory coverage. -
Extension6: string
Title:
Extension 6Read Only:trueMaximum Length:255The extension 6 name in the territory coverage. -
Extension6Code: string
Title:
Extension 6 CodeMaximum Length:30The extension 6 code in the territory coverage. -
Extension7: string
Title:
Extension 7Read Only:trueMaximum Length:255The extension 7 name in the territory coverage. -
Extension7Code: string
Title:
Extension 7 CodeMaximum Length:30The extension 7 code in the territory coverage. -
Extension8: string
Title:
Extension 8Read Only:trueMaximum Length:255The extension 8 name in the territory coverage. -
Extension8Code: string
Title:
Extension 8 CodeMaximum Length:30The extension 8 code in the territory coverage. -
Extension9: string
Title:
Extension 9Read Only:trueMaximum Length:255The extension 9 name in the territory coverage. -
Extension9Code: string
Title:
Extension 9 CodeMaximum Length:30The extension 9 code in the territory coverage. -
GeographyHighId: integer
(int64)
Title:
Geography High IDThe identifier for the higher geography in the range in the territory coverage. -
GeographyHighName: string
Title:
Geography High NameThe name for the higher geography in the range in the territory coverage. -
GeographyId: integer
(int64)
Title:
Geography IDThe identifier for the geography in the territory coverage. -
GeographyName: string
Title:
GeographyThe 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 HierarchyMaximum Length:1Indicates whether the dimension member is included along with its hierarchy or not. The default value is true. -
IndustryCode: string
Title:
Industry CodeMaximum Length:30The code for the industry in the territory coverage. -
IndustryName: string
Title:
IndustryRead Only:trueThe name of the industry in the territory coverage. -
InventoryItemId: integer
(int64)
Title:
Inventory Item IDThe identifier for the inventory item in the territory coverage. -
InventoryOrgId: integer
(int64)
Title:
Inventory Organization IDThe identifier for the inventory organization in the territory coverage. -
ItemName: string
Title:
Item NameRead Only:trueMaximum Length:240The name for the item in the territory coverage. -
ItemNumber: string
Title:
Item NumberRead Only:trueMaximum Length:300The number for the item in the territory coverage. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date the territory coverage was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the territory coverage. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login of the user who last updated the territory coverage. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrganizationType: string
Title:
Organization TypeRead Only:trueThe name of the organization type in the territory coverage. -
OrganizationTypeCode: string
Title:
Organization Type CodeMaximum Length:30The code for the organization type in the territory coverage. -
OriginalReference: string
Title:
Original ReferenceMaximum Length:300The origin source system reference of the account or contact. -
PartnerId: integer
(int64)
Title:
Partner IDThe identifier of the partner inclusion or exclusion. -
PartnerName: string
Title:
PartnerRead Only:trueMaximum Length:360The name of the partner inclusion. -
PartnerNumber: string
Title:
Partner NumberMaximum Length:30The public unique identifier of the partner inclusion or exclusion. -
ProductGroupId: integer
(int64)
Title:
Product Group IDThe identifier for the product group in the territory coverage. -
ProductGroupName: string
Title:
Product Group NameRead Only:trueMaximum Length:250The name for the product group in the territory coverage. -
ProductGroupNumber: string
Title:
Product Group NumberMaximum Length:50The number for the product group in the territory coverage. -
RegistryId: string
Title:
Registry IDRead Only:trueMaximum Length:30The public unique identifier of the customer inclusion. -
SalesChannelCode: string
Title:
Sales Channel CodeMaximum Length:30The code for the sales channel in the territory coverage. -
SubSalesChannelCode: string
Title:
Subsales Channel CodeMaximum Length:30The code for the sub sales channel in the territory coverage. -
TerrDimensionCode: string
Title:
Territory Dimension CodeMaximum Length:5The 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 IDThe unique identifier of territory version. -
UniqueTerritoryNumber: string
Title:
Unique Territory NumberMaximum Length:30The public unique identifier of the territory.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.