Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
curl --request PATCH \
--url http://localhost:3000/v2/companies/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"icon": {
"file": {},
"external": {},
"file_upload": {}
}
}
'import requests
url = "http://localhost:3000/v2/companies/{id}"
payload = { "icon": {
"file": {},
"external": {},
"file_upload": {}
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({icon: {file: {}, external: {}, file_upload: {}}})
};
fetch('http://localhost:3000/v2/companies/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v2/companies/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'icon' => [
'file' => [
],
'external' => [
],
'file_upload' => [
]
]
]),
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 := "http://localhost:3000/v2/companies/{id}"
payload := strings.NewReader("{\n \"icon\": {\n \"file\": {},\n \"external\": {},\n \"file_upload\": {}\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("http://localhost:3000/v2/companies/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"icon\": {\n \"file\": {},\n \"external\": {},\n \"file_upload\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/companies/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"icon\": {\n \"file\": {},\n \"external\": {},\n \"file_upload\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"object": "page",
"id": "p_abc123",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T14:45:00.000Z",
"document": "00000000000191",
"archived": false,
"createdBy": {
"object": "user",
"id": "u_abc123",
"apiKeyId": "bsk_abc123"
},
"updatedBy": {
"object": "user",
"id": "u_abc123",
"apiKeyId": "bsk_abc123"
},
"legalName": "<string>",
"tradeName": "<string>",
"icon": {
"type": "emoji",
"emoji": "page_icon",
"external": {
"url": "https://example.com/image.jpg"
},
"file_upload": {
"id": "fu_abc123"
},
"domain": "acme.com",
"file": {
"url": "https://s3.amazonaws.com/...",
"expiryTime": "2024-01-15T10:30:00.000Z"
},
"lucide": "file-text",
"brand": "github",
"dicebear": {
"style": "notionists-neutral",
"seed": "0256de50-f90c-49a8-81f0-3988b2b89d8d",
"backgroundColor": "b6e3f4,b6e3f4",
"options": {
"brows": "<string>",
"eyes": "<string>",
"glasses": "<string>",
"lips": "<string>",
"nose": "<string>",
"flip": true,
"rotate": 123,
"scale": 123,
"radius": 123,
"size": 123,
"backgroundType": "solid",
"backgroundRotation": [
123
],
"translateX": 123,
"translateY": 123,
"clip": true,
"randomizeIds": true
}
},
"background": "blue",
"empty": true,
"updatedBy": "dataset:empresas"
},
"archivedAt": "<string>",
"archivedBy": "<string>",
"addressState": "<string>",
"addressType": "<string>",
"addressStreet": "<string>",
"addressNumber": "<string>",
"addressComplement": "<string>",
"addressNeighborhood": "<string>",
"addressZipCode": "<string>",
"addressCity": "<string>",
"registrationStatus": "<string>",
"registrationStatusDate": "<string>",
"email": "<string>",
"phones": [
"<string>"
],
"companySize": "<string>",
"capital": "<string>",
"legalNatureCode": 123,
"legalNatureDescription": "<string>",
"simplesOption": true,
"simplesOptionDate": "<string>",
"meiOption": true,
"meiOptionDate": "<string>",
"mainCnae": {
"code": "<string>",
"description": "<string>"
},
"secondaryCnaes": [
{
"code": "<string>",
"description": "<string>"
}
],
"isHeadquarter": true,
"activityStartDate": "<string>"
}curl --request PATCH \
--url http://localhost:3000/v2/companies/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"icon": {
"file": {},
"external": {},
"file_upload": {}
}
}
'import requests
url = "http://localhost:3000/v2/companies/{id}"
payload = { "icon": {
"file": {},
"external": {},
"file_upload": {}
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({icon: {file: {}, external: {}, file_upload: {}}})
};
fetch('http://localhost:3000/v2/companies/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v2/companies/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'icon' => [
'file' => [
],
'external' => [
],
'file_upload' => [
]
]
]),
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 := "http://localhost:3000/v2/companies/{id}"
payload := strings.NewReader("{\n \"icon\": {\n \"file\": {},\n \"external\": {},\n \"file_upload\": {}\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("http://localhost:3000/v2/companies/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"icon\": {\n \"file\": {},\n \"external\": {},\n \"file_upload\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/companies/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"icon\": {\n \"file\": {},\n \"external\": {},\n \"file_upload\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"object": "page",
"id": "p_abc123",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T14:45:00.000Z",
"document": "00000000000191",
"archived": false,
"createdBy": {
"object": "user",
"id": "u_abc123",
"apiKeyId": "bsk_abc123"
},
"updatedBy": {
"object": "user",
"id": "u_abc123",
"apiKeyId": "bsk_abc123"
},
"legalName": "<string>",
"tradeName": "<string>",
"icon": {
"type": "emoji",
"emoji": "page_icon",
"external": {
"url": "https://example.com/image.jpg"
},
"file_upload": {
"id": "fu_abc123"
},
"domain": "acme.com",
"file": {
"url": "https://s3.amazonaws.com/...",
"expiryTime": "2024-01-15T10:30:00.000Z"
},
"lucide": "file-text",
"brand": "github",
"dicebear": {
"style": "notionists-neutral",
"seed": "0256de50-f90c-49a8-81f0-3988b2b89d8d",
"backgroundColor": "b6e3f4,b6e3f4",
"options": {
"brows": "<string>",
"eyes": "<string>",
"glasses": "<string>",
"lips": "<string>",
"nose": "<string>",
"flip": true,
"rotate": 123,
"scale": 123,
"radius": 123,
"size": 123,
"backgroundType": "solid",
"backgroundRotation": [
123
],
"translateX": 123,
"translateY": 123,
"clip": true,
"randomizeIds": true
}
},
"background": "blue",
"empty": true,
"updatedBy": "dataset:empresas"
},
"archivedAt": "<string>",
"archivedBy": "<string>",
"addressState": "<string>",
"addressType": "<string>",
"addressStreet": "<string>",
"addressNumber": "<string>",
"addressComplement": "<string>",
"addressNeighborhood": "<string>",
"addressZipCode": "<string>",
"addressCity": "<string>",
"registrationStatus": "<string>",
"registrationStatusDate": "<string>",
"email": "<string>",
"phones": [
"<string>"
],
"companySize": "<string>",
"capital": "<string>",
"legalNatureCode": 123,
"legalNatureDescription": "<string>",
"simplesOption": true,
"simplesOptionDate": "<string>",
"meiOption": true,
"meiOptionDate": "<string>",
"mainCnae": {
"code": "<string>",
"description": "<string>"
},
"secondaryCnaes": [
{
"code": "<string>",
"description": "<string>"
}
],
"isHeadquarter": true,
"activityStartDate": "<string>"
}OAuth2 Authorization Code flow
Company ID (cmp_*)
Company icon/logo
Show child attributes
Company updated
Object type
"page"
Unique identifier
"p_abc123"
Creation timestamp
"2024-01-15T10:30:00.000Z"
Last update timestamp
"2024-01-15T14:45:00.000Z"
"00000000000191"
Principal who created this object
Show child attributes
{
"object": "user",
"id": "u_abc123",
"apiKeyId": "bsk_abc123"
}
Principal who last updated this object
Show child attributes
{
"object": "user",
"id": "u_abc123",
"apiKeyId": "bsk_abc123"
}
Show child attributes
Show child attributes
Show child attributes