Create Segment
Create Segment
POST
https://api.ocamba.com/v1/hood/segments
Creates a new Segment objectRate limits:
- Burst: 10/s
- Steady: 150/m
Request schema
bodyResponse schemas
›
201
application/json
›
400
application/json
›
500
application/json
curl -X POST \
"https://api.ocamba.com/v1/hood/segments" \
-H "Authorization: Bearer {TOKEN}" \
-H "Content-Type: application/json" \
-d '{
"name": "US Android",
"status": "active",
"targeting": {
"countries": {
"items": [
"US"
],
"op": "eq"
},
"os": {
"items": [
"12"
],
"op": "eq"
},
"subscribed_age": {
"from": 1,
"to": 10
}
}
}'const url = 'https://api.ocamba.com/v1/hood/segments';
const options = {
method: 'POST',
headers: {
Authorization: "Bearer {TOKEN}",
'Content-Type': "application/json"
},
body: JSON.stringify(
{
"name": "US Android",
"status": "active",
"targeting": {
"countries": {
"items": [
"US"
],
"op": "eq"
},
"os": {
"items": [
"12"
],
"op": "eq"
},
"subscribed_age": {
"from": 1,
"to": 10
}
}
}
)
};
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/segments");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer {TOKEN}",
"Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(
[
"name" => "US Android",
"status" => "active",
"targeting" => [
"countries" => [
"items" => [
"US"
],
"op" => "eq"
],
"os" => [
"items" => [
"12"
],
"op" => "eq"
],
"subscribed_age" => [
"from" => 1,
"to" => 10
]
]
]
));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);Responses
201 Created
{
"id": "2221",
"company_id": "6197120",
"name": "US Android",
"status": "active",
"targeting": {
"countries": {
"items": [
"US"
],
"op": "eq"
},
"os": {
"items": [
"12"
],
"op": "eq"
},
"subscribed_age": {
"from": 1,
"to": 10
}
}
}
400 Bad Request
{
"code": 400,
"title": "Bad request.",
"message": "The request body 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
Note
At least one target is required.
We recommend using partners instead of accounts, as accounts are deprecated. If both parameters are sent, partners will take priority.
Warning
The following targeting fragments are deprecated: remote_users, customers, subscribed_age, user_data, tags, accounts. Instead use the following fragments which match the deprecated fragments, respectively: remote_ids, profiles, profile_age, custom_properties, containers, partners.