Update customer tenant ====================== Update a customer tenant. Prerequisites ^^^^^^^^^^^^^ - Credentials as described in :doc:`/getting-started/authentication` - A customer tenant type - A customer tenant identifier - An invoice profile identifier C# ^^ To update customer tenant, first instantiate **CustomerTenantDetailed** and set **Tenant** property with the required properties along with the property value that needs to be updated. Next, get the instance of **CrayonApiClient** and get the token using the instance. This token will be passed when updating the customer tenant. Finally, call **CustomerTenants.Update()** method to update customer tenant by passing token and the instance of **CustomerTenantDetailed**. .. code-block:: c# :emphasize-lines: 16 var customerTenantDetailed = new CustomerTenantDetailed { Tenant = new CustomerTenant { InvoiceProfile = new ObjectReference { Id = }, CustomerTenantType = <1 or 2>, Name = "", Id = , Reference = "", ResellerMarkup = } }; var client = new CrayonApiClient("https://api.crayon.com/"); var token = client.Tokens.GetUserToken(clientId, clientSecret, userName, password).GetData().AccessToken; var result = client.CustomerTenants.Update(token, customerTenantDetailed); Request ^^^^^^^ Request Syntax: +---------+-------------------------------------------------------------+ | Method | Request URI | +=========+=============================================================+ | PUT | *https://api.crayon.com/api/v1/customertenants/{id}/* | +---------+-------------------------------------------------------------+ Request Body: +-------------------+----------------------------------------------+-----------------------------------+ | Name | Type | Description | +===================+==============================================+===================================+ | customertenant | :doc:`/resources/CustomerTenantDetailed` | The customer to update | +-------------------+----------------------------------------------+-----------------------------------+ Request Headers: The following HTTP request headers are supported +------------------+----------------+-----------------------------------------------------------------+ | Header | Type | Description | +==================+================+=================================================================+ | Authorization | string | Required. The authorization token in the form Bearer . | +------------------+----------------+----------------------------------------------+------------------+ | Accept | string | Specifies the request and response type, "application/json". | +------------------+----------------+----------------------------------------------+------------------+ | Content-Type | string | Specifies the media type of the resource, "application/json". | +------------------+----------------+----------------------------------------------+------------------+ Request Example: :: PUT $"https://api.crayon.com/api/v1/customertenants/{id}/" Accept: application/json Content-Type: application/json Authorization: Bearer < Token > .. literalinclude:: /scenarios/_static/CustomerTenantRequest.json :language: json Response ^^^^^^^^ If successful, this method returns the updated customer tenant as a :doc:`/resources/CustomerTenantDetailed` resource in the response body. .. literalinclude:: /resources/_static/CustomerTenantDetailed.json :language: json Response success and error codes: Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use a network trace tool to read this code, error type, and additional parameters. +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Error Codes | Description | +================================+===========================================================================================================================================================================================================================================================================================+ | 200 Ok | The request has succeeded. | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 400 Bad Request | The request could not be understood by the server due to malformed syntax, missing required properties, properties that couldn't be parsed according to their type (and length). It is a non-retryable error condition. The client should not repeat the request without modifications. | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 401 Unauthorized | The request requires user authentication. If the request already included Authorization credentials, then the 401 (Unauthorized) status code means that authorization has been refused for those credentials. It is a non-retryable error condition. | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+