Add existing customer tenant
============================

Adds a customer tenant that already have existing subscriptions but is not visible

Prerequisites
^^^^^^^^^^^^^

- Credentials as described in :doc:`/getting-started/authentication`
- A customer tenant type
- An invoice profile identifier

C#
^^

To add existing customer tenant, first instantiate **CustomerTenantDetailed** and set **Tenant** property with the instantiated **CustomerTenant** along with its required properties.

Next, get the instance of **CrayonApiClient** and get the client token using the instance. This token will be passed when adding the existing customer tenant.

Finally, call **CustomerTenants.CreateExisting()** method to add existing customer tenant by passing the token and the instance of **CustomerTenantDetailed**.

.. code-block:: c#
	:emphasize-lines: 15

	var customerTenantDetailed = new CustomerTenantDetailed
	{
		Tenant = new CustomerTenant
		{
			DomainPrefix = "<your domain prefix>",
			Organization = new Organization { Id = <organization id> },
			Publisher = new ObjectReference { Id = <publisher id> },
			InvoiceProfile = new ObjectReference { Id = <invoice profile> },
			ExternalPublisherCustomerId = "<existing customer id>"
		}
	};

	var client = new CrayonApiClient("https://api.crayon.com/");
	var token = client.Tokens.GetUserToken(clientId, clientSecret, userName, password).GetData().AccessToken;
	var result = client.CustomerTenants.CreateExisting(token, customerTenantDetailed);


Request
^^^^^^^

Request Syntax:

+---------+-------------------------------------------------------------+
| Method  | Request URI                                                 |
+=========+=============================================================+
| POST    | *https://api.crayon.com/api/v1/customertenants/existing/*   |
+---------+-------------------------------------------------------------+

Request Body:

+-------------------+----------------------------------------------+-----------------------------------+
| Name              | Type                                         | Description                       |
+===================+==============================================+===================================+
| customertenant    | :doc:`/resources/CustomerTenantDetailed`     | The customer to add               |
+-------------------+----------------------------------------------+-----------------------------------+

Request Headers:

The following HTTP request headers are supported

+------------------+----------------+-----------------------------------------------------------------+
| Header           | Type           | Description                                                     |
+==================+================+=================================================================+
| Authorization    | string         | Required. The authorization token in the form Bearer <token>.   |
+------------------+----------------+----------------------------------------------+------------------+
| Accept           | string         | Specifies the request and response type, "application/json".    |
+------------------+----------------+----------------------------------------------+------------------+
| Content-Type     | string         | Specifies the media type of the resource, "application/json".   |
+------------------+----------------+----------------------------------------------+------------------+

Request Example:

::

	POST $"https://api.crayon.com/api/v1/customertenants/existing/"
	Accept: application/json
	Content-Type: application/json 
	Authorization: Bearer < Token >

.. literalinclude:: /scenarios/_static/ExistingCustomerTenantRequest.json
		:language: json

Response
^^^^^^^^
If successful, this method returns the created 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.                                      |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+