Update customer

PATCH/customers/update/{customerId}

Request

curl --request PATCH \
  --url 'https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/customers/update/CUSTOMER_ID' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'x-api-secret: YOUR_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Maria Silva",
  "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
  },
  "cascadeUpdate": true
}'

const response = await fetch('https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/customers/update/CUSTOMER_ID', {
  method: 'PATCH',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'x-api-secret': 'YOUR_API_SECRET',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Maria Silva",
    "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
    },
    "cascadeUpdate": true
  }),
});

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

import requests

url = "https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/customers/update/CUSTOMER_ID"
headers = {
    "x-api-key": "YOUR_API_KEY",
    "x-api-secret": "YOUR_API_SECRET",
}
payload = {
    "name": "Maria Silva",
    "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,
    },
    "cascadeUpdate": True,
}

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

Response

{
  "statusCode": 200,
  "data": {
    "updated": true,
    "cascade": {
      "subscriptions": 1,
      "billings": 2
    }
  }
}

{
  "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": 404,
  "message": "Customer not found",
  "error": "Not Found"
}

{
  "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.

Path parameters

customerIdstringrequired

Request body

Content typeapplication/jsonobject

namestring
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
documentobject
Show child attributesHide child attributes
- typestring
  Possible values:CPFCNPJ
- numberstring
phoneobject
Show child attributesHide child attributes
- areaCodestring
- dddstring
- numberstring
- isMobileboolean
cascadeUpdateboolean
When true, the updated customer data is also copied to the customer's subscriptions with status active or inactive and to the customer's charges with status draft, opened, active, inactive or delayed. Any other value is treated as false.

Default:false

Responses

200Returns whether the customer was updated and, when cascadeUpdate is true, how many subscriptions and charges received the new data.

Returns whether the customer was updated and, when cascadeUpdate is true, how many subscriptions and charges received the new data.

Content typeapplication/jsonobject

statusCodeinteger
Example:200
dataobject
Show child attributesHide child attributes
- updatedboolean
- cascadeobject
  Present only when cascadeUpdate is true and the customer was updated.
  Show child attributesHide child attributes
  subscriptionsinteger
  Number of subscriptions that received the new customer data.
  
  billingsinteger
  Number of charges that received the new customer data.

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

404The customer does not exist or does not belong to your business.

The customer does not exist or does not belong to your business.

Content typeapplication/jsonobject

statusCodeintegerrequired
HTTP status code.
messagestringrequired
Explanation of the error.
errorstring
Name of the HTTP status, such as Bad Request or Conflict.
errorCodestring
Code that identifies the error. Present only on some errors.

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