User Guides Developer Guides API Reference Changelog
⌘ K

Update profile

Update profile

PATCH https://api.ocamba.com/v1/hood/profiles/{id}

Updates a specific profile by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Rate limits:

Burst: 10/s
Steady: 150/m

Path parameters

parameters

Request schema

body
PATCH https://api.ocamba.com/v1/hood/profiles/{id} HTTP/1.1
Host: api.ocamba.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
{
  "comment": "New profile",
  "custom_properties": "{\n  \"clicker\":\"1\"\n}",
  "mobile_phone_number": "+49658245684",
  "email": "[email protected]",
  "organization_id": 1000023,
  "lists": [
    "1000102"
  ],
  "full_name": "John Doe"
}

curl -X PATCH "https://api.ocamba.com/v1/hood/profiles/{id}" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"comment":"New profile","custom_properties":"{\n  \"clicker\":\"1\"\n}","mobile_phone_number":"+49658245684","email":"[email protected]","organization_id":1000023,"lists":["1000102"],"full_name":"John Doe"}'

fetch("https://api.ocamba.com/v1/hood/profiles/{id}", {
  method: "PATCH",
  headers: { Authorization: `Bearer ${TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify(
    {
      "comment": "New profile",
      "custom_properties": "{\n  \"clicker\":\"1\"\n}",
      "mobile_phone_number": "+49658245684",
      "email": "[email protected]",
      "organization_id": 1000023,
      "lists": [
        "1000102"
      ],
      "full_name": "John Doe"
    }
  )
}).then(r => r.json());

$ch = curl_init("https://api.ocamba.com/v1/hood/profiles/{id}");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "Authorization: Bearer $token",
  "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(
  [
    "comment" => "New profile",
    "custom_properties" => "[\n  \"clicker\" =>\"1\"\n]",
    "mobile_phone_number" => "+49658245684",
    "email" => "[email protected]",
    "organization_id" => 1000023,
    "lists" => [
      "1000102"
    ],
    "full_name" => "John Doe"
  ]
));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);

Responses

204 No Content

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

Note
1
Updatable fields are email, mobile_phone_number, full_name, organization_id, lists, comment and custom_properties.
2
At least one of the updatable fields should be sent via HTTP body in order to change the current state of the profile.
Tip
1
If you don’t know the profile ‘id’, list the profiles to find it.