Searching:
0 results found
BackTenants/Patch or Tenants/Put
PATCH /odata/Tenants/Patch/[tenantId]
– OR –
PUT /odata/Tenants/Put/[tenantId]
Description
To update an existing Tenant.
See the following for request and response details ‒
See Also
Request ‒ Tenants/Patch or Put
In the request, specify the ID of the Tenant whose definition to change and the name of the property(s) to change. These properties are described in Tenants/Post.
For the Patch endpoint, all unspecified fields remain unchanged.
For the Put endpoint, all unspecified fields are assigned default values.
| Property | Type | Description | Mandatory |
| tenantId | String | This is the unique identifier (tenantId) that is automatically assigned by Axonize when a Tenant is created. This tenantId is returned in the response of the Tenants/Post. | Y |
Example JSON Tenants/Patch Request
The following is an example of changing a Tenant’s name to new tenant name.
curl -X POST \
https://api.stg.axonize.com/odata/tenants/ \
-H ‘Authorization: Token’ \
-H ‘Content-Type: application/json’ \
-H ‘appId: 801A048A-9F23-429F-BF0D-B6D35B22771E’ \
-d ‘{
“name”:”new tenant name”,
}
‘
Response ‒ Tenants/Patch or Put
| Property | Type | Description |
| createDate, createUser, updateDate, updateUser | See Common Response Properties. |
Example JSON Tenants/Patch/Put Response
Status 204 – No Content – The server has successfully fulfilled the request.