curl --request POST \
--url https://api.ephra.io/v1/customers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Mariana Ribeiro Alves",
"document": "390.533.447-05",
"email": "mariana.alves@exemplo.com.br",
"phone": "+5521998877665",
"mailMarketing": true,
"address": {
"street": "Rua Visconde de Pirajá",
"streetNumber": "414",
"complement": "sala 1108",
"neighborhood": "Ipanema",
"city": "Rio de Janeiro",
"state": "RJ",
"zipCode": "22410-002"
}
}
'import requests
url = "https://api.ephra.io/v1/customers"
payload = {
"name": "Mariana Ribeiro Alves",
"document": "390.533.447-05",
"email": "mariana.alves@exemplo.com.br",
"phone": "+5521998877665",
"mailMarketing": True,
"address": {
"street": "Rua Visconde de Pirajá",
"streetNumber": "414",
"complement": "sala 1108",
"neighborhood": "Ipanema",
"city": "Rio de Janeiro",
"state": "RJ",
"zipCode": "22410-002"
}
}
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: 'Mariana Ribeiro Alves',
document: '390.533.447-05',
email: 'mariana.alves@exemplo.com.br',
phone: '+5521998877665',
mailMarketing: true,
address: {
street: 'Rua Visconde de Pirajá',
streetNumber: '414',
complement: 'sala 1108',
neighborhood: 'Ipanema',
city: 'Rio de Janeiro',
state: 'RJ',
zipCode: '22410-002'
}
})
};
fetch('https://api.ephra.io/v1/customers', 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.ephra.io/v1/customers",
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' => 'Mariana Ribeiro Alves',
'document' => '390.533.447-05',
'email' => 'mariana.alves@exemplo.com.br',
'phone' => '+5521998877665',
'mailMarketing' => true,
'address' => [
'street' => 'Rua Visconde de Pirajá',
'streetNumber' => '414',
'complement' => 'sala 1108',
'neighborhood' => 'Ipanema',
'city' => 'Rio de Janeiro',
'state' => 'RJ',
'zipCode' => '22410-002'
]
]),
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.ephra.io/v1/customers"
payload := strings.NewReader("{\n \"name\": \"Mariana Ribeiro Alves\",\n \"document\": \"390.533.447-05\",\n \"email\": \"mariana.alves@exemplo.com.br\",\n \"phone\": \"+5521998877665\",\n \"mailMarketing\": true,\n \"address\": {\n \"street\": \"Rua Visconde de Pirajá\",\n \"streetNumber\": \"414\",\n \"complement\": \"sala 1108\",\n \"neighborhood\": \"Ipanema\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"zipCode\": \"22410-002\"\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.ephra.io/v1/customers")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Mariana Ribeiro Alves\",\n \"document\": \"390.533.447-05\",\n \"email\": \"mariana.alves@exemplo.com.br\",\n \"phone\": \"+5521998877665\",\n \"mailMarketing\": true,\n \"address\": {\n \"street\": \"Rua Visconde de Pirajá\",\n \"streetNumber\": \"414\",\n \"complement\": \"sala 1108\",\n \"neighborhood\": \"Ipanema\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"zipCode\": \"22410-002\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ephra.io/v1/customers")
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\": \"Mariana Ribeiro Alves\",\n \"document\": \"390.533.447-05\",\n \"email\": \"mariana.alves@exemplo.com.br\",\n \"phone\": \"+5521998877665\",\n \"mailMarketing\": true,\n \"address\": {\n \"street\": \"Rua Visconde de Pirajá\",\n \"streetNumber\": \"414\",\n \"complement\": \"sala 1108\",\n \"neighborhood\": \"Ipanema\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"zipCode\": \"22410-002\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "cmtxc7d910004hlg1q8w2ker3",
"name": "Mariana Ribeiro Alves",
"email": "mariana.alves@exemplo.com.br",
"phone": "+5521998877665",
"document": "39053344705",
"documentType": "CPF",
"instagram": "@mariana.alves",
"birthDate": "1991-04-17T00:00:00.000Z",
"mailMarketing": true,
"taxFree": false,
"tags": [
"lancamento-setembro",
"cliente-recorrente"
],
"notes": "Pediu nota fiscal com o CNPJ da empresa dela a partir da próxima compra.",
"address": {
"street": "Rua Visconde de Pirajá",
"streetNumber": "414",
"complement": "sala 1108",
"neighborhood": "Ipanema",
"city": "Rio de Janeiro",
"state": "RJ",
"zipCode": "22410002"
},
"createdAt": "2026-08-14T11:20:33.000Z",
"updatedAt": "2026-09-09T16:41:02.000Z"
}
}{
"success": false,
"message": "Não foi possível concluir: uma regra de negócio recusou os dados enviados."
}{
"success": false,
"message": "Token inválido ou expirado"
}{
"success": false,
"message": "name: Nome é obrigatório"
}{
"success": false,
"message": "Muitas requisições. Tente novamente em breve."
}{
"success": false,
"message": "Erro interno do servidor"
}Cadastrar um cliente
Cria um cliente da empresa autenticada para vendas registradas fora do checkout. O tipo do documento é deduzido do número e um documento inválido responde 400. Se já existir um cliente com o mesmo documento, ele é devolvido em vez de duplicado.
curl --request POST \
--url https://api.ephra.io/v1/customers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Mariana Ribeiro Alves",
"document": "390.533.447-05",
"email": "mariana.alves@exemplo.com.br",
"phone": "+5521998877665",
"mailMarketing": true,
"address": {
"street": "Rua Visconde de Pirajá",
"streetNumber": "414",
"complement": "sala 1108",
"neighborhood": "Ipanema",
"city": "Rio de Janeiro",
"state": "RJ",
"zipCode": "22410-002"
}
}
'import requests
url = "https://api.ephra.io/v1/customers"
payload = {
"name": "Mariana Ribeiro Alves",
"document": "390.533.447-05",
"email": "mariana.alves@exemplo.com.br",
"phone": "+5521998877665",
"mailMarketing": True,
"address": {
"street": "Rua Visconde de Pirajá",
"streetNumber": "414",
"complement": "sala 1108",
"neighborhood": "Ipanema",
"city": "Rio de Janeiro",
"state": "RJ",
"zipCode": "22410-002"
}
}
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: 'Mariana Ribeiro Alves',
document: '390.533.447-05',
email: 'mariana.alves@exemplo.com.br',
phone: '+5521998877665',
mailMarketing: true,
address: {
street: 'Rua Visconde de Pirajá',
streetNumber: '414',
complement: 'sala 1108',
neighborhood: 'Ipanema',
city: 'Rio de Janeiro',
state: 'RJ',
zipCode: '22410-002'
}
})
};
fetch('https://api.ephra.io/v1/customers', 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.ephra.io/v1/customers",
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' => 'Mariana Ribeiro Alves',
'document' => '390.533.447-05',
'email' => 'mariana.alves@exemplo.com.br',
'phone' => '+5521998877665',
'mailMarketing' => true,
'address' => [
'street' => 'Rua Visconde de Pirajá',
'streetNumber' => '414',
'complement' => 'sala 1108',
'neighborhood' => 'Ipanema',
'city' => 'Rio de Janeiro',
'state' => 'RJ',
'zipCode' => '22410-002'
]
]),
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.ephra.io/v1/customers"
payload := strings.NewReader("{\n \"name\": \"Mariana Ribeiro Alves\",\n \"document\": \"390.533.447-05\",\n \"email\": \"mariana.alves@exemplo.com.br\",\n \"phone\": \"+5521998877665\",\n \"mailMarketing\": true,\n \"address\": {\n \"street\": \"Rua Visconde de Pirajá\",\n \"streetNumber\": \"414\",\n \"complement\": \"sala 1108\",\n \"neighborhood\": \"Ipanema\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"zipCode\": \"22410-002\"\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.ephra.io/v1/customers")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Mariana Ribeiro Alves\",\n \"document\": \"390.533.447-05\",\n \"email\": \"mariana.alves@exemplo.com.br\",\n \"phone\": \"+5521998877665\",\n \"mailMarketing\": true,\n \"address\": {\n \"street\": \"Rua Visconde de Pirajá\",\n \"streetNumber\": \"414\",\n \"complement\": \"sala 1108\",\n \"neighborhood\": \"Ipanema\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"zipCode\": \"22410-002\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ephra.io/v1/customers")
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\": \"Mariana Ribeiro Alves\",\n \"document\": \"390.533.447-05\",\n \"email\": \"mariana.alves@exemplo.com.br\",\n \"phone\": \"+5521998877665\",\n \"mailMarketing\": true,\n \"address\": {\n \"street\": \"Rua Visconde de Pirajá\",\n \"streetNumber\": \"414\",\n \"complement\": \"sala 1108\",\n \"neighborhood\": \"Ipanema\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"zipCode\": \"22410-002\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "cmtxc7d910004hlg1q8w2ker3",
"name": "Mariana Ribeiro Alves",
"email": "mariana.alves@exemplo.com.br",
"phone": "+5521998877665",
"document": "39053344705",
"documentType": "CPF",
"instagram": "@mariana.alves",
"birthDate": "1991-04-17T00:00:00.000Z",
"mailMarketing": true,
"taxFree": false,
"tags": [
"lancamento-setembro",
"cliente-recorrente"
],
"notes": "Pediu nota fiscal com o CNPJ da empresa dela a partir da próxima compra.",
"address": {
"street": "Rua Visconde de Pirajá",
"streetNumber": "414",
"complement": "sala 1108",
"neighborhood": "Ipanema",
"city": "Rio de Janeiro",
"state": "RJ",
"zipCode": "22410002"
},
"createdAt": "2026-08-14T11:20:33.000Z",
"updatedAt": "2026-09-09T16:41:02.000Z"
}
}{
"success": false,
"message": "Não foi possível concluir: uma regra de negócio recusou os dados enviados."
}{
"success": false,
"message": "Token inválido ou expirado"
}{
"success": false,
"message": "name: Nome é obrigatório"
}{
"success": false,
"message": "Muitas requisições. Tente novamente em breve."
}{
"success": false,
"message": "Erro interno do servidor"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Nome completo do cliente.
1 - 160CPF ou CNPJ do cliente, com ou sem máscara. O tipo é deduzido do número.
11E-mail principal do cliente.
Telefone do cliente, com DDI e DDD.
8Perfil do Instagram do cliente.
60Data de nascimento (ISO 8601).
Marque true quando o cliente aceitou receber marketing.
Marque true quando o cliente é isento de imposto.
Etiquetas livres para segmentar o cliente.
201Anotações internas sobre o cliente.
1000Endereço de entrega do cliente.
Show child attributes
Show child attributes
