Create Consumer¶

Create a consumer.

Prerequisites¶

Credentials as described in Authentication

C#¶

To create consumer, first instantiate Consumer and set Name, LegalName and Organization.

Next, get the instance of CrayonApiClient and then get the client token using the instance. This client token will be passed when creating the user

Finally, call Consumers.Create() method to create user by passing the token and the instance of Consumer.

var consumer = new Consumer
{
        Name = "name",
        LegalName = "LegalName",
        Organization = new ObjectReference {
    Id = 4013596,
    Name = "CrayonCustomer"
}
};

var client = new CrayonApiClient("http://v1.api.crayon.as/");
var token = client.Tokens.GetUserToken(clientId, clientSecret, userName, password).GetData().AccessToken;
var result = client.Consumers.Create(token, consumer);

Request¶

Request Syntax:

Method	Request URI
POST	https://api.crayon.com/api/v1/consumers/

Request Body:

Name	Type	Description
consumer \| Consumer		The consumer to create

Consumer Properties:

Name	Type	Required
Name	string	Yes
LegalName	string	Yes
Organization	ObjectReference	Yes

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/consumers/"
Accept: application/json
Content-Type: application/json
Authorization: Bearer < Token >

{
    "Name": "Name",
    "LegalName": "LegalName",
    "Organization": {
        "Id": 4013596,
        "Name": "CustomerName"
    }
}

Response¶

If successful, this method returns the created user as a Consumer resource in the response body.

Response Body:

{
    "Id": 2066,
    "Name": "name",
    "LegalName": "LegalName",
    "Organization": {
        "Id": 4013596,
        "Name": "OrganizationName"
    }
}

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.

Create Consumer¶

Prerequisites¶

C#¶

Request¶

Response¶

Was this page helpful?

Was this page helpful?