Create category
Creates a new custom category for the authenticated company. The name must be unique among the company’s categories. Company context is taken from the access token.
curl -X POST "https://api-sandbox.contasimples.com/categories/v1/categories" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-d '{
"name": "Electronics"
}'
import requests
import json
url = "https://api-sandbox.contasimples.com/categories/v1/categories"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
"name": "Electronics"
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api-sandbox.contasimples.com/categories/v1/categories", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
},
body: JSON.stringify({
"name": "Electronics"
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"name": "Electronics"
}`)
req, err := http.NewRequest("POST", "https://api-sandbox.contasimples.com/categories/v1/categories", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api-sandbox.contasimples.com/categories/v1/categories')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.body = '{
"name": "Electronics"
}'
response = http.request(request)
puts response.body
{
"id": 1146,
"createdAt": "2024-12-25T10:00:00Z",
"updatedAt": "2024-12-25T10:00:00Z",
"companyId": "7c61b3f6-7353-46aa-80ef-3e27d95150ab",
"name": "Electronics",
"establishments": [
{
"id": 16,
"createdAt": "2024-12-25T10:00:00Z",
"updatedAt": "2024-12-25T10:00:00Z",
"name": "Amazon Prime Aluguel",
"type": {
"id": 1,
"createdAt": "2024-12-25T10:00:00Z",
"updatedAt": "2024-12-25T10:00:00Z",
"type": "CUSTOM"
},
"establishmentCategoryId": 1039
}
],
"type": {
"id": 1,
"createdAt": "2024-12-25T10:00:00Z",
"updatedAt": "2024-12-25T10:00:00Z",
"type": "CUSTOM"
}
}
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Conflict",
"message": "The request conflicts with the current state of the resource",
"code": 409,
"details": "Resource already exists"
}
{
"error": "Internal Server Error",
"message": "An unexpected error occurred on the server",
"code": 500,
"requestId": "req_1234567890"
}
/categories/v1/categories
Bearer token from OAuth 2.0 client credentials. Format: Bearer {token}
Bearer {token}The media type of the request body
Name of the category to create.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. Bearer token from OAuth 2.0 client credentials. Format: Bearer {token}
Body
Name of the category to create.
Responses
Category numeric ID.
When the category was created (ISO 8601).
When the category was updated (ISO 8601).
Owning company ID.
Category display name or accounting code.
Establishments linked to this category.
Establishment ID.
When the establishment record was created (ISO 8601).
When the establishment was updated (ISO 8601).
Display name of the establishment.
Type metadata for the establishment link.
Link between establishment and category ID.
Category type metadata (e.g. CUSTOM or DEFAULT).
Invalid body (for example, missing or empty name field).
Unauthorized. Token missing, invalid, or expired.
A category with the same name already exists for the company.
Internal server error. Retry with exponential backoff.
Last updated today
Built with Documentation.AI