---
title: /customers/{document}
slug: customersdocument
createdAt: 2023-07-20T14:59:31.346Z
---

{
  "id": "NhF56QTtCUuihsBuSY1bn",
  "type": "api-oas-v2",
  "data": {
    "method": "PATCH",
    "url": "/customers/{document}",
    "name": "/customers/{document}",
    "description": "<p>Atualiza e-mail e/ou celular do cliente.</p>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [
        {
          "kind": "required",
          "name": "document",
          "type": "string",
          "description": "Documento do cliente"
        }
      ],
      "headerParameters": [],
      "queryParameters": [],
      "bodyDataParameters": [
        {
          "kind": "required",
          "name": "body",
          "type": "object",
          "customType": "UpdateCustomerDto",
          "schema": [
            {
              "name": "email",
              "kind": "optional",
              "type": "string",
              "description": "E-mail do cliente"
            },
            {
              "name": "cellphone",
              "kind": "optional",
              "type": "string",
              "description": "Celular com código do país (55)",
              "example": "5511999999999"
            }
          ],
          "modelRef": "#/components/schemas/UpdateCustomerDto",
          "isExpanded": true
        }
      ],
      "formDataParameters": [],
      "oAuthParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "Cliente atualizado com sucesso",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "customType": "CustomerProfileResultDto",
            "schema": [
              {
                "name": "id",
                "kind": "required",
                "type": "number",
                "description": "Identificador do perfil do cliente"
              },
              {
                "name": "customer_id",
                "kind": "required",
                "type": "number",
                "description": "Identificador do cliente"
              },
              {
                "name": "account_id",
                "kind": "required",
                "type": "number",
                "description": "Identificador da conta"
              },
              {
                "name": "email",
                "kind": "required",
                "type": "string",
                "description": "E-mail do cliente"
              },
              {
                "name": "cellphone",
                "kind": "required",
                "type": "string",
                "description": "Celular com código do país (55)",
                "example": "5511999999999"
              },
              {
                "name": "created_at",
                "kind": "required",
                "type": "string<date-time>",
                "description": "Data de criação do perfil"
              },
              {
                "name": "updated_at",
                "kind": "required",
                "type": "string<date-time>",
                "description": "Data da última atualização"
              },
              {
                "name": "customer",
                "kind": "required",
                "type": "object",
                "schema": [
                  {
                    "name": "id",
                    "kind": "required",
                    "type": "number",
                    "description": "Identificador do cliente"
                  },
                  {
                    "name": "name",
                    "kind": "required",
                    "type": "string",
                    "description": "Nome completo do cliente"
                  },
                  {
                    "name": "document",
                    "kind": "required",
                    "type": "string",
                    "description": "Documento do cliente",
                    "example": "12345678901"
                  },
                  {
                    "name": "birthdate",
                    "kind": "optional",
                    "type": "string<date-time>",
                    "description": "Data de nascimento"
                  },
                  {
                    "name": "created_at",
                    "kind": "required",
                    "type": "string<date-time>",
                    "description": "Data de criação do cliente"
                  },
                  {
                    "name": "updated_at",
                    "kind": "required",
                    "type": "string<date-time>",
                    "description": "Data da última atualização"
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/CustomerProfileResultDto",
            "isExpanded": true
          }
        ]
      }
    ],
    "examples": {
      "languages": [
        {
          "id": "example-0-curl",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request PATCH \\\n     --url /customers/{document} \\\n     --header 'accept: application/json'"
        },
        {
          "id": "example-1-javascript",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'PATCH',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"/customers/{document}\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "example-2-ruby",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"/customers/{document}\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Patch.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = http.request(request)\nputs response.read_body\n"
        },
        {
          "id": "example-3-python",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"/customers/{document}\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"PATCH\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "example-0-curl"
    },
    "results": {
      "languages": [
        {
          "id": "response-0-200",
          "language": "200",
          "code": "// Cliente atualizado com sucesso\n{\n  \"id\": 0,\n  \"customer_id\": 0,\n  \"account_id\": 0,\n  \"email\": \"\",\n  \"cellphone\": \"5511999999999\",\n  \"created_at\": \"\",\n  \"updated_at\": \"\",\n  \"customer\": {\n    \"id\": 0,\n    \"name\": \"\",\n    \"document\": \"12345678901\",\n    \"birthdate\": \"\",\n    \"created_at\": \"\",\n    \"updated_at\": \"\"\n  }\n}"
        }
      ],
      "selectedLanguageId": "response-0-200"
    }
  },
  "children": [
    {
      "id": "bjjYwAXKaT13VwjorVNAb",
      "type": "paragraph",
      "children": [
        {
          "text": "Atualiza e-mail e/ou celular do cliente."
        }
      ]
    }
  ]
}