Create Container group

Create Container group

POST https://api.ocamba.com/v1/hood/groups
Creates a new Container group object

Rate limits:

  • Burst: 10/s
  • Steady: 150/m

Request schema

body

Response schemas

curl -X POST \
 "https://api.ocamba.com/v1/hood/groups" \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "first",
  "color": "#836265",
  "description": "My first Group",
  "item_ids": [
    "30677878",
    "44676391",
    "7403921"
  ]
}'
const url = 'https://api.ocamba.com/v1/hood/groups';
const options = {
  method: 'POST',
  headers: {
    Authorization: "Bearer {TOKEN}",
    'Content-Type': "application/json"
  },
  body: JSON.stringify(
    {
      "name": "first",
      "color": "#836265",
      "description": "My first Group",
      "item_ids": [
        "30677878",
        "44676391",
        "7403921"
      ]
    }
  )
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
$ch = curl_init("https://api.ocamba.com/v1/hood/groups");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "Authorization: Bearer {TOKEN}",
  "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(
  [
    "name" => "first",
    "color" => "#836265",
    "description" => "My first Group",
    "item_ids" => [
      "30677878",
      "44676391",
      "7403921"
    ]
  ]
));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);

Responses

201 Created

{
  "id": "1535",
  "company_id": "6197120",
  "name": "first",
  "color": "#836265",
  "num_of_items": 3,
  "description": "My first Group",
  "item_ids": [
    "30677878",
    "44676391",
    "7403921"
  ]
}

400 Bad Request

{
  "code": 400,
  "title": "Bad request.",
  "message": "The request body is not valid.",
  "trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}

500 Internal Server Error

{
  "code": 500,
  "title": "Internal server error.",
  "trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}
Responses