Update Integration

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

Updates a specific Integration by setting the values of the parameters passed. 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 integration.

Tip

If you don’t know the Integration ‘id’, list the Integrations to find it.

Warning

The settings substructure differs based on provider id. Every field that does not belong the provider specified by the provider id will be omitted.

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/integrations/{id}" \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Content-Type: application/json" \
  -d '"{\n  \"name\": \"Test Patch\",\n  \"status\": \"active\",\n  \"settings\": \n  {\n    \"account_sid\": \"ACfXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n    \"auth_token\": \"f9cXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n    \"default_phone_number\":\"1324XXXXXXXX\"\n  },\n}"'

const url = 'https://api.ocamba.com/v1/hood/integrations/{id}';
const options = {
  method: 'PATCH',
  headers: {
    Authorization: "Bearer {TOKEN}",
    'Content-Type': "application/json"
  },
  body: JSON.stringify(
    "{\n  \"name\": \"Test Patch\",\n  \"status\": \"active\",\n  \"settings\": \n  {\n    \"account_sid\": \"ACfXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n    \"auth_token\": \"f9cXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n    \"default_phone_number\":\"1324XXXXXXXX\"\n  },\n}"
  )
};

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/integrations/{id}");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "Authorization: Bearer {TOKEN}",
  "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(
  "[\n  \"name\" => \"Test Patch\",\n  \"status\" => \"active\",\n  \"settings\" => \n  [\n    \"account_sid\" => \"ACfXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n    \"auth_token\" => \"f9cXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n    \"default_phone_number\" =>\"1324XXXXXXXX\"\n  ],\n]"
));
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