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.

Note

Updatable fields are email, mobile_phone_number, full_name, organization_id, lists, comment and custom_properties. At least one of the updatable fields should be sent via HTTP body in order to change the current state of the profile.

Tip

If you don’t know the profile ‘id’, list the profiles to find it.

Rate limits:

Burst: 10/s
Steady: 150/m

Path parameters

parameters

Request schema

body

Response schemas

•

204

No Content

›

400

application/json

›

500

application/json

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

const url = 'https://api.ocamba.com/v1/hood/profiles/{id}';
const options = {
  method: 'PATCH',
  headers: {
    Authorization: "Bearer {TOKEN}",
    'Content-Type': "application/json"
  },
  body: JSON.stringify(
    {
      "full_name": "John Doe",
      "mobile_phone_number": "+49658245684",
      "email": "[email protected]",
      "organization_id": "1000",
      "lists": [
        "1000102"
      ],
      "custom_properties": {
        "clicker": "1"
      },
      "comment": "New comment for profile"
    }
  )
};

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/profiles/{id}");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "Authorization: Bearer {TOKEN}",
  "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(
  [
    "full_name" => "John Doe",
    "mobile_phone_number" => "+49658245684",
    "email" => "[email protected]",
    "organization_id" => "1000",
    "lists" => [
      "1000102"
    ],
    "custom_properties" => [
      "clicker" => "1"
    ],
    "comment" => "New comment for profile"
  ]
));
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

LinkedIn Facebook Instagram