Update profile Property

Update profile Property

PATCH https://api.ocamba.com/v1/hood/profile-properties/{id}
Updates the specific profile Property. Any parameters not provided will be left unchanged.

Note
At least one of the updatable fields should be sent via HTTP body in order to change the current state of the Property. System properties are not updatable.
Tip
If you don’t know the id, list the profile Properties to find it.

Rate limits:

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

Path parameters

parameters

Request schema

body

Response schemas

204
No Content
curl -X PATCH \
 "https://api.ocamba.com/v1/hood/profile-properties/{id}" \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
  "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
}'
const url = 'https://api.ocamba.com/v1/hood/profile-properties/{id}';
const options = {
  method: 'PATCH',
  headers: {
    Authorization: "Bearer {TOKEN}",
    'Content-Type': "application/json"
  },
  body: JSON.stringify(
    {
      "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
    }
  )
};

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/profile-properties/{id}");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "Authorization: Bearer {TOKEN}",
  "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(
  [
    "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

204 No Content

400 Bad Request

{
  "code": 400,
  "title": "Bad request.",
  "message": "The request 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