Cadastros

Cria cliente

POST/api/v1/clientes

Cria um registro. Exige chave de leitura e escrita com usuário responsável; mande Idempotency-Key para poder repetir sem duplicar. A criação dispara os webhooks e as automações da conta, como a tela.

Exige chave com escopo READ_WRITE. Aceita o header Idempotency-Key.

Escopo da chave

Exige chave de leitura e escrita (READ_WRITE) com usuário responsável.

Parâmetros

Nome	Onde	Tipo	Obrigatório	Descrição
`Authorization`	header	string	sim	Bearer seguido da chave. Alternativa: cabeçalho X-API-Key.
`Idempotency-Key`	header	string	não	Chave de idempotência (guardada por 24h, corpo de até 2 MB). Repetir a MESMA chave com o MESMO corpo devolve a resposta original gravada, marcada com o header X-Idempotency-Replay: true — nada é executado de novo. A mesma chave com corpo DIFERENTE recebe 409 (conflito); a mesma chave enquanto a primeira execução ainda roda recebe 409 com Retry-After: 5. Resposta 5xx não congela a chave: a repetição executa de novo.

Corpo da requisição

Nome	Tipo	Obrigatório	Descrição
`nome`	string	sim	Nome.
`email`	string	não	E-mail.
`cpfCnpj`	string	não	CPF ou CNPJ, como cadastrado.
`telefone`	string	não	Telefone.

Campos da resposta

Nome	Tipo	Descrição
`id`	integer	Identificador do registro. Use-o nas chamadas por id.
`codigo`	integer	Código do registro como aparece na tela.
`nome`	string	Nome.

Códigos de status

HTTP	Descrição
201	Criado
401	Chave ausente ou inválida
403	Chave sem escopo de escrita

Mensagens de erro

HTTP	Mensagem (campo erro)	Quando acontece
401	`chave de API ausente ou inválida`	Sem cabeçalho de chave, chave revogada ou digitada errada.
401	`chave sem empresa vinculada`	A chave existe mas não está ligada a uma conta. Gere outra em Configurações › API.
403	`conta de demonstração: a API pública está desligada na vitrine`	A chamada veio para a conta de demonstração: lá a API pública fica desligada.
403	`identidade da chave de API irregular`	A conta recusa chaves com identidade irregular (pessoa desligada ou chave sem dono). O corpo traz motivo e comoResolver.
429	`limite de requisições excedido (120/min)`	Passou do limite por minuto da chave. Espere o Retry-After.
403	`esta chave é somente leitura — gere uma chave com escopo de escrita`	Escrita com chave de escopo somente leitura.
409	`a chave não tem usuário responsável; recrie a chave em Configurações → API para que os registros criados tenham autoria`	A chave de escrita não tem usuário responsável: sem autoria, nada é gravado.
400	`Idempotency-Key é obrigatória em escrita desde 2026-12-01 (aviso publicado em 2026-09-01): sem ela, um retry de rede cria o registro duas vezes. Envie um valor único por operação no cabeçalho Idempotency-Key.`	Escrita sem Idempotency-Key depois da data de obrigatoriedade.
409	`Idempotency-Key já usada com um corpo DIFERENTE — gere uma chave nova por operação`	A mesma Idempotency-Key veio com outro corpo.
409	`requisicao com esta Idempotency-Key ainda em processamento — aguarde e repita`	A mesma Idempotency-Key chegou enquanto a primeira chamada ainda rodava. Repita depois do Retry-After.
400	`JSON inválido`	O corpo não é um objeto JSON válido.
422	`nome é obrigatório`	Faltou nome, ou veio vazio.
422	`não foi possível criar: {detalhe}`	A gravação foi recusada (por exemplo, valor maior que o campo aceita). O detalhe vem na mensagem.

Exemplo de chamada

cURL

curl -X POST "https://tenka.app.br/api/v1/clientes" \
  -H "Authorization: Bearer $TENKA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "nome": "Comercial Aurora Ltda",
  "email": "contato@exemplo.com",
  "cpfCnpj": "12.345.678/0001-00",
  "telefone": "+55 11 99999-0000"
}'

JavaScript

const response = await fetch("https://tenka.app.br/api/v1/clientes", {
  method: "POST",
  headers: {
    "Authorization": "Bearer " + TENKA_API_KEY,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID()
  },
  body: JSON.stringify({
    "nome": "Comercial Aurora Ltda",
    "email": "contato@exemplo.com",
    "cpfCnpj": "12.345.678/0001-00",
    "telefone": "+55 11 99999-0000"
  })
});
const data = await response.json();
if (!response.ok || data.erro) throw new Error(response.status + " " + data.erro);
console.log(data);

Python

import os
import uuid
import requests

response = requests.post(
    "https://tenka.app.br/api/v1/clientes",
    headers={
        "Authorization": f"Bearer {os.environ['TENKA_API_KEY']}",
        "Content-Type": "application/json",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
      "nome": "Comercial Aurora Ltda",
      "email": "contato@exemplo.com",
      "cpfCnpj": "12.345.678/0001-00",
      "telefone": "+55 11 99999-0000"
    },
    timeout=30,
)
data = response.json()
if not response.ok or "erro" in data:
    raise RuntimeError(f"{response.status_code} {data.get('erro')}")
print(data)

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder(URI.create("https://tenka.app.br/api/v1/clientes"))
    .header("Authorization", "Bearer " + System.getenv("TENKA_API_KEY"))
    .header("Content-Type", "application/json")
    .header("Idempotency-Key", java.util.UUID.randomUUID().toString())
    .POST(HttpRequest.BodyPublishers.ofString("""
        {
          "nome": "Comercial Aurora Ltda",
          "email": "contato@exemplo.com",
          "cpfCnpj": "12.345.678/0001-00",
          "telefone": "+55 11 99999-0000"
        }
        """))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());

using System.Net.Http.Headers;
using System.Text;

using var http = new HttpClient();
http.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("TENKA_API_KEY"));
var request = new HttpRequestMessage(HttpMethod.Post, "https://tenka.app.br/api/v1/clientes");
request.Headers.Add("Idempotency-Key", Guid.NewGuid().ToString());
request.Content = new StringContent(@"{
  ""nome"": ""Comercial Aurora Ltda"",
  ""email"": ""contato@exemplo.com"",
  ""cpfCnpj"": ""12.345.678/0001-00"",
  ""telefone"": ""+55 11 99999-0000""
}", Encoding.UTF8, "application/json");
var response = await http.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");

PHP

<?php
$ch = curl_init("https://tenka.app.br/api/v1/clientes");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("TENKA_API_KEY"),
        "Content-Type: application/json",
        "Idempotency-Key: " . bin2hex(random_bytes(16)),
    ],
    CURLOPT_POSTFIELDS => '{
  "nome": "Comercial Aurora Ltda",
  "email": "contato@exemplo.com",
  "cpfCnpj": "12.345.678/0001-00",
  "telefone": "+55 11 99999-0000"
}',
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
$data = json_decode($body, true);
echo $status . " " . $body;

Node (SDK)

// SDK gerado do contrato — baixe em https://tenka.app.br/api/v1/sdk/tenka.js
import { Tenka } from "./tenka.js";

const tenka = new Tenka(process.env.TENKA_API_KEY, "https://tenka.app.br/api/v1");
const data = await tenka.postClientes({}, {
    "nome": "Comercial Aurora Ltda",
    "email": "contato@exemplo.com",
    "cpfCnpj": "12.345.678/0001-00",
    "telefone": "+55 11 99999-0000"
  }, crypto.randomUUID());
console.log(data);

Exemplo de resposta

201 · application/json

{
  "id": 123,
  "codigo": 1042,
  "nome": "Comercial Aurora Ltda"
}

Gerado do contrato OpenAPI v1.2.0, o mesmo que o openapi.json publica. openapi.json