Update Variable
Update Variable
PATCH
https://api.ocamba.com/v1/hood/variables/{id}
Updates a specific Variable 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
parametersRequest schema
bodyPATCH https://api.ocamba.com/v1/hood/variables/{id} HTTP/1.1
Host: api.ocamba.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
{
"settings": {},
"formatting": {},
"description": "This is an example of description."
}
curl -X PATCH "https://api.ocamba.com/v1/hood/variables/{id}" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"settings":{},"formatting":{},"description":"This is an example of description."}'
fetch("https://api.ocamba.com/v1/hood/variables/{id}", {
method: "PATCH",
headers: { Authorization: `Bearer ${TOKEN}`, "Content-Type": "application/json" },
body: JSON.stringify(
{
"settings": {},
"formatting": {},
"description": "This is an example of description."
}
)
}).then(r => r.json());
$ch = curl_init("https://api.ocamba.com/v1/hood/variables/{id}");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer $token",
"Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(
[
"settings" => [],
"formatting" => [],
"description" => "This is an example of description."
]
));
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
At least one of the updatable fields should be sent via HTTP body in order to change the current state of the variable.
Tip
1
If you don’t know the Variable ‘id’, list the Variables to find it.