Create customer

POST/customers

Route to create customer

Request

curl --request POST \
  --url 'https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/customers' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'x-api-secret: YOUR_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
  "businessId": "8b1d2f4e-5a6c-4e7f-9a0b-1c2d3e4f5a6b",
  "name": "Maria Silva",
  "email": "maria@example.com",
  "contactEmail": "maria.contact@example.com",
  "address": {
    "zipCode": "01001000",
    "street": "Rua Exemplo",
    "complement": "Apto 12",
    "neighborhood": "Centro",
    "city": "São Paulo",
    "state": "SP",
    "number": "100"
  },
  "deliveryAddress": {
    "zipCode": "01001000",
    "street": "Rua Exemplo",
    "complement": "Apto 12",
    "neighborhood": "Centro",
    "city": "São Paulo",
    "state": "SP",
    "number": "100"
  },
  "document": {
    "type": "CPF",
    "number": "12345678909"
  },
  "phone": {
    "areaCode": "+55",
    "ddd": "11",
    "number": "912345678",
    "isMobile": true
  }
}'

const response = await fetch('https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/customers', {
  method: 'POST',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'x-api-secret': 'YOUR_API_SECRET',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "businessId": "8b1d2f4e-5a6c-4e7f-9a0b-1c2d3e4f5a6b",
    "name": "Maria Silva",
    "email": "maria@example.com",
    "contactEmail": "maria.contact@example.com",
    "address": {
      "zipCode": "01001000",
      "street": "Rua Exemplo",
      "complement": "Apto 12",
      "neighborhood": "Centro",
      "city": "São Paulo",
      "state": "SP",
      "number": "100"
    },
    "deliveryAddress": {
      "zipCode": "01001000",
      "street": "Rua Exemplo",
      "complement": "Apto 12",
      "neighborhood": "Centro",
      "city": "São Paulo",
      "state": "SP",
      "number": "100"
    },
    "document": {
      "type": "CPF",
      "number": "12345678909"
    },
    "phone": {
      "areaCode": "+55",
      "ddd": "11",
      "number": "912345678",
      "isMobile": true
    }
  }),
});

const data = await response.json();
console.log(data);

import requests

url = "https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/customers"
headers = {
    "x-api-key": "YOUR_API_KEY",
    "x-api-secret": "YOUR_API_SECRET",
}
payload = {
    "businessId": "8b1d2f4e-5a6c-4e7f-9a0b-1c2d3e4f5a6b",
    "name": "Maria Silva",
    "email": "maria@example.com",
    "contactEmail": "maria.contact@example.com",
    "address": {
        "zipCode": "01001000",
        "street": "Rua Exemplo",
        "complement": "Apto 12",
        "neighborhood": "Centro",
        "city": "São Paulo",
        "state": "SP",
        "number": "100",
    },
    "deliveryAddress": {
        "zipCode": "01001000",
        "street": "Rua Exemplo",
        "complement": "Apto 12",
        "neighborhood": "Centro",
        "city": "São Paulo",
        "state": "SP",
        "number": "100",
    },
    "document": {
        "type": "CPF",
        "number": "12345678909",
    },
    "phone": {
        "areaCode": "+55",
        "ddd": "11",
        "number": "912345678",
        "isMobile": True,
    },
}

response = requests.post(url, headers=headers, json=payload)
print(response.json())

Response

{
  "statusCode": 200,
  "data": {
    "customer": {
      "id": "6650f1a2b3c4d5e6f7a8b9c0",
      "createdAt": "2026-01-15T12:00:00.000Z",
      "updatedAt": "2026-01-15T12:00:00.000Z",
      "deleted": false,
      "name": "Maria Silva",
      "businessId": "8b1d2f4e-5a6c-4e7f-9a0b-1c2d3e4f5a6b",
      "userId": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
      "email": "maria@example.com",
      "phone": {
        "areaCode": "+55",
        "ddd": "11",
        "number": "912345678",
        "isMobile": true
      },
      "address": {
        "zipCode": "01001000",
        "street": "Rua Exemplo",
        "number": "100",
        "complement": "Apto 12",
        "neighborhood": "Centro",
        "city": "São Paulo",
        "state": "SP"
      },
      "deliveryAddress": {
        "zipCode": "01001000",
        "street": "Rua Exemplo",
        "number": "100",
        "complement": "Apto 12",
        "neighborhood": "Centro",
        "city": "São Paulo",
        "state": "SP"
      },
      "document": {
        "type": "CPF",
        "number": "12345678909"
      }
    }
  }
}

{
  "message": "Invalid param: []",
  "error": "Bad Request",
  "statusCode": 400,
  "errorCode": "string"
}

Generated from the schema

{
  "message": "Unauthorized",
  "error": "Unauthorized",
  "statusCode": 401
}

Generated from the schema

{
  "message": "Forbidden resource",
  "error": "Forbidden",
  "statusCode": 403
}

Generated from the schema

{
  "statusCode": 500,
  "message": "Internal Server Error"
}

Generated from the schema

Headers

x-api-keystringrequired
Api key provided on integrations tab in Easyflow platform.
x-api-secretstringrequired
Api Secret provided on integrations tab in Easyflow platform.

Request body

Content typeapplication/jsonobject

businessIdstringrequired
namestringrequired
emailstringrequired
contactEmailstring · email
Optional contact email for the customer. It must be a valid email address and is stored in lowercase, without surrounding spaces.
addressobject
Show child attributesHide child attributes
- zipCodestring
- streetstring
- complementstring
- neighborhoodstring
- citystring
- statestring
  The state must send an abbreviation (Example: sp)
- numberstring
deliveryAddressobject
Show child attributesHide child attributes
- zipCodestring
- streetstring
- complementstring
- neighborhoodstring
- citystring
- statestring
  The state must send an abbreviation (Example: sp)
- numberstring
documentobjectrequired
Show child attributesHide child attributes
- typestring
  Possible values:CPFCNPJ
- numberstring
phoneobject
Show child attributesHide child attributes
- areaCodestring
- dddstring
- numberstring
- isMobileboolean

Responses

200returns customer if you managed to create the customer.

returns customer if you managed to create the customer.

Content typeapplication/jsonobject

statusCodeinteger
Example:200
dataobject
Show child attributesHide child attributes
- customerobject
  Show child attributesHide child attributes
  idstring
  createdAtstring
  updatedAtstring
  deletedboolean
  namestring
  businessIdstring
  userIdstring
  emailstring
  phoneobject
  Show child attributesHide child attributes
  areaCodestring
  dddstring
  numberstring
  isMobileboolean
  addressobject
  Show child attributesHide child attributes
  zipCodestring
  streetstring
  numberstring
  complementstring
  neighborhoodstring
  citystring
  statestring
  The state must send an abbreviation (Example: sp)
  
  deliveryAddressobject
  Show child attributesHide child attributes
  zipCodestring
  streetstring
  numberstring
  complementstring
  neighborhoodstring
  citystring
  statestring
  The state must send an abbreviation (Example: sp)
  
  documentobject
  Show child attributesHide child attributes
  typestring
  Possible values:CPFCNPJ
  numberstring

400If the provided parameter is invalid, the API will return the following error response:

If the provided parameter is invalid, the API will return the following error response:

Content typeapplication/jsonobject

messagestring
Invalid param: []

Example:Invalid param: []
errorstring
Bad Request

Example:Bad Request
statusCodeinteger
400

Example:400
errorCodestring
Code that identifies the error. Present only on some errors.

401If the request is unauthorized, the API will return the following error response:

If the request is unauthorized, the API will return the following error response:

Content typeapplication/jsonobject

messagestring
Invalid field

Example:Unauthorized
errorstring
Unauthorized

Example:Unauthorized
statusCodeinteger
401

Example:401

403If the request is forbidden, the API will return the following error response:

If the request is forbidden, the API will return the following error response:

Content typeapplication/jsonobject

messagestring
Forbidden resource

Example:Forbidden resource
errorstring
Forbidden

Example:Forbidden
statusCodeinteger
403

Example:403

500If an unexpected condition occurs and the server cannot process the request, the API will return the following error response. This response has no error field.

If an unexpected condition occurs and the server cannot process the request, the API will return the following error response. This response has no error field.

Content typeapplication/jsonobject

statusCodeinteger
HTTP status code.

Example:500
messagestring
Explanation of the error.

Example:Internal Server Error