Import Profiles Commit

Import Profiles Commit

POST https://api.ocamba.com/v1/hood/profiles/imports/{id}/commit
Finalizing the data import and saving the profile information into the Ocamba system.

Note
At least one of email or mobile_phone_number is required.

Rate limits:

  • Burst: 10/s
  • Steady: 150/m

Path parameters

parameters

Request schema

body

Response schemas

curl -X POST \
 "https://api.ocamba.com/v1/hood/profiles/imports/{id}/commit" \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
  "mapping": [
    {
      "label": "email",
      "property": {
        "label": "email",
        "data_type": "text",
        "system": 1
      }
    },
    {
      "label": "phone",
      "property": {
        "label": "mobile_phone_number",
        "data_type": "text",
        "system": 1
      }
    },
    {
      "label": "name",
      "property": {
        "label": "full_name",
        "data_type": "text",
        "system": 1
      }
    },
    {
      "label": "column",
      "property": {
        "label": "custom_column",
        "data_type": "text",
        "system": 0
      }
    }
  ]
}'
const url = 'https://api.ocamba.com/v1/hood/profiles/imports/{id}/commit';
const options = {
  method: 'POST',
  headers: {
    Authorization: "Bearer {TOKEN}",
    'Content-Type': "application/json"
  },
  body: JSON.stringify(
    {
      "mapping": [
        {
          "label": "email",
          "property": {
            "label": "email",
            "data_type": "text",
            "system": 1
          }
        },
        {
          "label": "phone",
          "property": {
            "label": "mobile_phone_number",
            "data_type": "text",
            "system": 1
          }
        },
        {
          "label": "name",
          "property": {
            "label": "full_name",
            "data_type": "text",
            "system": 1
          }
        },
        {
          "label": "column",
          "property": {
            "label": "custom_column",
            "data_type": "text",
            "system": 0
          }
        }
      ]
    }
  )
};

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/imports/{id}/commit");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "Authorization: Bearer {TOKEN}",
  "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(
  [
    "mapping" => [
      [
        "label" => "email",
        "property" => [
          "label" => "email",
          "data_type" => "text",
          "system" => 1
        ]
      ],
      [
        "label" => "phone",
        "property" => [
          "label" => "mobile_phone_number",
          "data_type" => "text",
          "system" => 1
        ]
      ],
      [
        "label" => "name",
        "property" => [
          "label" => "full_name",
          "data_type" => "text",
          "system" => 1
        ]
      ],
      [
        "label" => "column",
        "property" => [
          "label" => "custom_column",
          "data_type" => "text",
          "system" => 0
        ]
      ]
    ]
  ]
));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);

Responses

202 Accepted

{
  "id": "c50f31e8-35a9-456a-b44a-e87d60c5570c",
  "company_id": "6197120",
  "member_id": "1000165",
  "status": "running",
  "start_time": "2025-06-12 09:39:01"
}

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