POST client-brand

A lookup call to request a new client or client-brand pair be added to the master data list.

When accessed via a POST request this API method will create a new client/brand pair. Your HTTP body should consist of JSON similar to the following samples.

Each attribute type/value will be validated to ensure that the data is valid. See the section on errors for how errors are represented.

INPUT to create a brand for an existing client

As this method is accessed via a POST request the raw body must be set to JSON as described below. Note that this is sample input.

{
    "client_id": 5,
    "brand_name": "coca"
}
        

The table below details the fields used in this example.

parameter type description
client_id integer Id of an existing client to which the brand being requested is to be linked to
brand_name string Name of a brand

INPUT to create a new client/brand pair

As this method is accessed via a POST request the raw body must be set to JSON as described below. Note that this is sample input.

{
    "client_name": "heinekken",
    "brand_name": "coca"
}
        

The table below details the fields used in this example.

parameter type description
client_name string Name of a client
brand_name string (optional) Name of a brand

If no brand name is sent only a client record will be created.

OUTPUT - JSON sample

{
    "data": {
        "request_id": 3011
    }
}
        

The request_id can then be used in GET /api/client-brand-status to fetch the status of your request