curl --request POST \
--url https://api.getcargo.io/v1/revenueOrganization/capacities \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"modelUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"idColumnSlug": "<string>",
"timeColumnSlug": "<string>",
"memberCapacity": 123,
"allocationExpirationPolicy": {
"interval": "hourly",
"minute": 123
}
}
'import requests
url = "https://api.getcargo.io/v1/revenueOrganization/capacities"
payload = {
"name": "<string>",
"description": "<string>",
"modelUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"idColumnSlug": "<string>",
"timeColumnSlug": "<string>",
"memberCapacity": 123,
"allocationExpirationPolicy": {
"interval": "hourly",
"minute": 123
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
modelUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
idColumnSlug: '<string>',
timeColumnSlug: '<string>',
memberCapacity: 123,
allocationExpirationPolicy: {interval: 'hourly', minute: 123}
})
};
fetch('https://api.getcargo.io/v1/revenueOrganization/capacities', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getcargo.io/v1/revenueOrganization/capacities",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'modelUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'idColumnSlug' => '<string>',
'timeColumnSlug' => '<string>',
'memberCapacity' => 123,
'allocationExpirationPolicy' => [
'interval' => 'hourly',
'minute' => 123
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.getcargo.io/v1/revenueOrganization/capacities"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"modelUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"idColumnSlug\": \"<string>\",\n \"timeColumnSlug\": \"<string>\",\n \"memberCapacity\": 123,\n \"allocationExpirationPolicy\": {\n \"interval\": \"hourly\",\n \"minute\": 123\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.getcargo.io/v1/revenueOrganization/capacities")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"modelUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"idColumnSlug\": \"<string>\",\n \"timeColumnSlug\": \"<string>\",\n \"memberCapacity\": 123,\n \"allocationExpirationPolicy\": {\n \"interval\": \"hourly\",\n \"minute\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcargo.io/v1/revenueOrganization/capacities")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"modelUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"idColumnSlug\": \"<string>\",\n \"timeColumnSlug\": \"<string>\",\n \"memberCapacity\": 123,\n \"allocationExpirationPolicy\": {\n \"interval\": \"hourly\",\n \"minute\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"capacity": {
"uuid": "<string>",
"workspaceUuid": "<string>",
"name": "<string>",
"color": "orange",
"description": "<string>",
"memberCapacity": 123,
"allocationExpirationPolicy": {
"interval": "hourly",
"minute": 123
},
"modelUuid": "<string>",
"idColumnSlug": "<string>",
"timeColumnSlug": "<string>",
"filter": {
"conjonction": "or",
"groups": [
{
"conjonction": "or",
"conditions": [
{
"kind": "sql",
"name": "<string>",
"clause": "<string>"
}
]
}
]
},
"syncedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>"
}
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}Create capacity
Create a new capacity (POST /revenueOrganization/capacities).
curl --request POST \
--url https://api.getcargo.io/v1/revenueOrganization/capacities \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"modelUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"idColumnSlug": "<string>",
"timeColumnSlug": "<string>",
"memberCapacity": 123,
"allocationExpirationPolicy": {
"interval": "hourly",
"minute": 123
}
}
'import requests
url = "https://api.getcargo.io/v1/revenueOrganization/capacities"
payload = {
"name": "<string>",
"description": "<string>",
"modelUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"idColumnSlug": "<string>",
"timeColumnSlug": "<string>",
"memberCapacity": 123,
"allocationExpirationPolicy": {
"interval": "hourly",
"minute": 123
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
modelUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
idColumnSlug: '<string>',
timeColumnSlug: '<string>',
memberCapacity: 123,
allocationExpirationPolicy: {interval: 'hourly', minute: 123}
})
};
fetch('https://api.getcargo.io/v1/revenueOrganization/capacities', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getcargo.io/v1/revenueOrganization/capacities",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'modelUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'idColumnSlug' => '<string>',
'timeColumnSlug' => '<string>',
'memberCapacity' => 123,
'allocationExpirationPolicy' => [
'interval' => 'hourly',
'minute' => 123
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.getcargo.io/v1/revenueOrganization/capacities"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"modelUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"idColumnSlug\": \"<string>\",\n \"timeColumnSlug\": \"<string>\",\n \"memberCapacity\": 123,\n \"allocationExpirationPolicy\": {\n \"interval\": \"hourly\",\n \"minute\": 123\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.getcargo.io/v1/revenueOrganization/capacities")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"modelUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"idColumnSlug\": \"<string>\",\n \"timeColumnSlug\": \"<string>\",\n \"memberCapacity\": 123,\n \"allocationExpirationPolicy\": {\n \"interval\": \"hourly\",\n \"minute\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcargo.io/v1/revenueOrganization/capacities")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"modelUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"idColumnSlug\": \"<string>\",\n \"timeColumnSlug\": \"<string>\",\n \"memberCapacity\": 123,\n \"allocationExpirationPolicy\": {\n \"interval\": \"hourly\",\n \"minute\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"capacity": {
"uuid": "<string>",
"workspaceUuid": "<string>",
"name": "<string>",
"color": "orange",
"description": "<string>",
"memberCapacity": 123,
"allocationExpirationPolicy": {
"interval": "hourly",
"minute": 123
},
"modelUuid": "<string>",
"idColumnSlug": "<string>",
"timeColumnSlug": "<string>",
"filter": {
"conjonction": "or",
"groups": [
{
"conjonction": "or",
"conditions": [
{
"kind": "sql",
"name": "<string>",
"clause": "<string>"
}
]
}
]
},
"syncedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>"
}
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}Authorizations
API token from cargo-ai login. Send as Authorization: Bearer <token>.
Headers
Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.
255"8e03978e-40d5-43e8-bc93-6894a57f9324"
Body
Request body schema.
Capacity name.
1 - 255Capacity color.
orange, red, purple, green, yellow, grey Capacity description.
1 - 1000Model identifier for capacity mapping.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$Identifier column slug.
Time column slug.
Capacity per member.
Allocation expiration schedule.
- Allocation expiration policy
- Allocation expiration policy
- Allocation expiration policy
- Allocation expiration policy
- Allocation expiration policy
- Allocation expiration policy
Show child attributes
Show child attributes
Filter criteria for capacity.
Show child attributes
Show child attributes
Response
Create capacity
Created capacity details.
Show child attributes
Show child attributes
Was this page helpful?

