Create profile Property

POST https://api.ocamba.com/v1/hood/profile-properties HTTP/1.1
Host: api.ocamba.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
{
  "label": "my_region",
  "data_type": "text",
  "example": "northern_europe",
  "description": "Custom region information associated with the profile. Can be used to group or filter profiles based on regional segmentation defined by your organization.",
  "export_alias": "region_name",
  "pi_data": 1,
  "importable": 1,
  "exportable": 1
}

curl -X POST "https://api.ocamba.com/v1/hood/profile-properties" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"label":"my_region","data_type":"text","example":"northern_europe","description":"Custom region information associated with the profile. Can be used to group or filter profiles based on regional segmentation defined by your organization.","export_alias":"region_name","pi_data":1,"importable":1,"exportable":1}'

fetch("https://api.ocamba.com/v1/hood/profile-properties", {
  method: "POST",
  headers: { Authorization: `Bearer ${TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify(
    {
      "label": "my_region",
      "data_type": "text",
      "example": "northern_europe",
      "description": "Custom region information associated with the profile. Can be used to group or filter profiles based on regional segmentation defined by your organization.",
      "export_alias": "region_name",
      "pi_data": 1,
      "importable": 1,
      "exportable": 1
    }
  )
}).then(r => r.json());

$ch = curl_init("https://api.ocamba.com/v1/hood/profile-properties");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "Authorization: Bearer $token",
  "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(
  [
    "label" => "my_region",
    "data_type" => "text",
    "example" => "northern_europe",
    "description" => "Custom region information associated with the profile. Can be used to group or filter profiles based on regional segmentation defined by your organization.",
    "export_alias" => "region_name",
    "pi_data" => 1,
    "importable" => 1,
    "exportable" => 1
  ]
));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);

Responses

201 Created

HTTP/1.1 201 Created
Content-Type: application/json

{
  "id": "1000105",
  "company_id": "7196310",
  "target": "my_region",
  "label": "my_region",
  "data_type": "text",
  "example": "northern_europe",
  "description": "Custom region information associated with the profile. Can be used to group or filter profiles based on regional segmentation defined by your organization.",
  "import_aliases": [
    "region_name"
  ],
  "export_alias": "region_name",
  "pi_data": 1,
  "system": 1,
  "importable": 1,
  "exportable": 1,
  "create_time": "2025-01-29 12:47:00",
  "update_time": "2025-01-30 14:27:26"
}

400 Bad Request

HTTP/1.1 400 Bad Request
Content-Type: application/json

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

500 Internal Server Error

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

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