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.

Rate limits:

Burst: 10/s
Steady: 150/m

Path parameters

parameters

Request schema

body

Response schemas

PATCH https://api.ocamba.com/v1/hood/profile-properties/{id} HTTP/1.1
Host: api.ocamba.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
{
  "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"
}
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"}'
fetch("https://api.ocamba.com/v1/hood/profile-properties/{id}", {
  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"
    }
  )
}).then(r => r.json());
$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"
  ]
));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);

Responses

204 No Content

HTTP/1.1 204 No Content
Content-Type: application/json

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"
}
Responses

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