Organization update request
Description
Updates an Organization with specified details. Updates FoundationCostCenter and FoundationLocation records as well if they are passed as part of Organization parameter. If more than one objects are passed, FoundationCostCenter and FoundationLocation not present in the payload will be deleted from CLM.
API stability classification
API overview
HTTP | URI | Return | Return type |
|---|---|---|---|
POST | csm/Organization/guid |
|
HTTP request message
Query string parameters
This API does not use query string parameters.
Request message headers
This API uses only common headers listed in HTTP-request-and-response-headers.
Request message body
This API uses the following objects in the request message body JSON.
Top-level objects
Name | Type | Multi- | Description |
|---|---|---|---|
callbackURL | String | 0..1 | URL to call when the operation finishes |
postCallout | String | 0..1 | Identifier of a callout to run after the operation executes |
preCallout | String | 0..1 | Identifier of a callout to run before the operation executes |
timeout | Integer | 0..1 | Timeout setting. For more information about using the timeout, see Synchronous-and-asynchronous-operations. Timeout values:
|
operationParams | 1 | Array of input parameters. The following table contains the list of input parameters. For information about setting up the input parameters, see Passing-input-parameters-with-an-API-request. |
Input parameters to include in operationParams
Name | Type | Multi- | Description |
|---|---|---|---|
additionalInfo | 0..* | Additional information about organization, specify in key value format. Internal business logic will not use these key-value pairs, however callouts can make use of these. | |
isRemote | boolean | 0..1 | Reserved. This parameter should not be passed or pass 'false' value. |
organization | 1 | Organization object with all the required attributes. |
HTTP response message
Response message headers
This API uses only common headers listed in HTTP-request-and-response-headers.
Response message body
The response message body contains a Task object.