Skip to main content
POST
/
{alias}
/
customers
Criar cliente
curl --request POST \
  --url https://api.dooki.com.br/v2/{alias}/customers \
  --header 'Content-Type: application/json' \
  --header 'User-Secret-Key: <api-key>' \
  --header 'User-Token: <api-key>' \
  --data '
{
  "active": true,
  "cpf": "<string>",
  "cnpj": "<string>",
  "email": "<string>",
  "homephone": "<string>",
  "marketplace_id": 123,
  "cluster_id": 123,
  "name": "<string>",
  "razao_social": "<string>",
  "birthday": "2000-06-01",
  "ip": "<string>",
  "utm_source": "<string>",
  "utm_campaign": "<string>",
  "notes": "<string>"
}
'
{
  "data": [
    {
      "id": 123,
      "merchant_id": 123,
      "marketplace_id": 123,
      "active": true,
      "type": "<string>",
      "cluster_id": 123,
      "name": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "generic_name": "<string>",
      "cpf": "<string>",
      "spreadsheet": {
        "data": {
          "brands": "<string>",
          "city": "<string>",
          "purchased_brands": "<string>",
          "last_order_date": {
            "date": "2023-11-07T05:31:56Z",
            "timezone_type": 123,
            "timezone": "<string>"
          },
          "last_order_value": "<string>",
          "purchased_categories": "<string>",
          "number": "<string>",
          "uf": "<string>",
          "phone": "(16) 98187-5668",
          "street": "<string>",
          "phone_number": "981875668",
          "categories": "<string>",
          "neighborhood": "<string>",
          "complement": "<string>",
          "phone_code": "16"
        }
      },
      "phone": {
        "area_code": "<string>",
        "full_number": "<string>",
        "number": "<string>",
        "formated_number": "<string>",
        "whatsapp_link": "<string>"
      },
      "razao_social": "<string>",
      "cnpj": "<string>",
      "state_registration": "<string>",
      "email": "jsmith@example.com",
      "birthday": "2023-12-25",
      "newsletter": true,
      "whatsapp": true,
      "social_driver": "<string>",
      "social_id": 123,
      "ip": "<string>",
      "token": "<string>",
      "utm_source": "<string>",
      "utm_campaign": "<string>",
      "notes": "<string>",
      "login_url": "<string>",
      "anonymized": true
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.yampi.com.br/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
User-Token
string
header
required
​
User-Secret-Key
string
header
required

Path Parameters

​
alias
string
required

Alias da loja

Body

application/json

Representa os dados necessários para criar ou atualizar um cliente

​
active
boolean
required

Status do cliente

​
type
enum<string>
required

Tipo de cliente (f para físico, j para jurídico)

Available options:
f,
j
​
cpf
string
required

CPF do cliente

​
cnpj
string | null
required

CNPJ do cliente

​
email
string
required

E-mail do cliente

​
homephone
string
required

Telefone residencial

​
marketplace_id
integer | null

ID do marketplace

​
cluster_id
integer | null

ID do cluster

​
name
string

Nome do cliente

​
razao_social
string | null

Razão social

​
birthday
string<date-time>

Esse campo somente se torna obrigatório caso haja configuração da regra no checkout. Data de aniversário do cliente.

Example:

"2000-06-01"

​
ip
string

IP do cliente

​
utm_source
string

Fonte UTM

​
utm_campaign
string

Campanha UTM

​
notes
string

Notas sobre o cliente

Response

Cliente criado com sucesso

​
data
Customer · object[]