Update a company profile
patch
/crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/CompanyProfiles/{Id}
Request
Path Parameters
-
Id(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=
-
Name(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
Root Schema : schema
Type:
Show Source
object
-
Addressline: string
Maximum Length:
100
The first line of the organization address. -
BusinessUnit: string
Maximum Length:
80
Business Unit -
CorporateCurrency: string
Maximum Length:
80
Default Value:USD
The default corporate currency code. -
Country: string
Maximum Length:
80
Default Value:US
The country of the enterprise. -
EnterpriseName: string
Maximum Length:
100
The name of the enterprise. -
IsDataExisting: string
Maximum Length:
80
Indicates if the enterprise setup data was created before running the Setup Assistant. -
LegalEntity: string
Maximum Length:
80
Legal Entity -
TaxRegNumber: string
Maximum Length:
80
Enterprise Tax Registration Number
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 : setupAssistants-CompanyProfiles-item-response
Type:
Show Source
object
-
Addressline: string
Maximum Length:
100
The first line of the organization address. -
BusinessUnit: string
Maximum Length:
80
Business Unit -
CorporateCurrency: string
Maximum Length:
80
Default Value:USD
The default corporate currency code. -
Country: string
Maximum Length:
80
Default Value:US
The country of the enterprise. -
EnterpriseName: string
Maximum Length:
100
The name of the enterprise. -
Id: string
Maximum Length:
80
The unique identifier of the company profile setup task. -
IsDataExisting: string
Maximum Length:
80
Indicates if the enterprise setup data was created before running the Setup Assistant. -
LegalEntity: string
Maximum Length:
80
Legal Entity -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TaxRegNumber: string
Maximum Length:
80
Enterprise Tax Registration Number
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.