MiaRec REST API

› › › ›
 

Create a client

Request to create new client:

POST /api/v2/clients.json

HTTP body should contain JSON formatted profile of client to create.

For example:

{
    "client": {
        “tenant_id”:         “156340bf-8b47-21e4-95a4-e03f497dbd44”,
        “name”:              “Contoso”,
        "contacts": [{
            "phone_number": "1234567890",
            "name": null
        }]
    }
}

Response contains HTTP status code as shown in the following table.

Response Description
201 Created Client has been successfully created. HTTP header Location contains URL by which the newly created object should be know.

For example:

HTTP/1.1 201 Created
Location: /api/v2/clients/e011c408-f288-11e4-9b73-e03f497dbdff.json

403 Forbidden The request cannot be completed because API user has no permission to create clients
400 Bad Request The request cannot be completed because supplied JSON object has invalid data.

When response has content type application/json, then it contains more detailed description of error in JSON format like:

{
    "error": "InvalidRecord",
    "description": "Record Validation errors",
    "details": [
        "name": "Client with such name exists already"
   ]
}