---
title: "Alteração do usuário"
method: PATCH
path: "/pockets/{pocketNumber}/users"
tags: ["Conta pocket"]
---

# Alteração do usuário

`PATCH /pockets/{pocketNumber}/users`

## Request

- Base URL: `https://api-mtls.sandbox.bankly.com.br`
- URL: `https://api-mtls.sandbox.bankly.com.br/pockets/{pocketNumber}/users`
- Auth: HTTP bearer

<div class="bkly-ref-description">
  <p>Realize a alteração do usuário de uma conta pocket.</p> 
  <span class="bkly-ref-small-stable-tag">stable</span> 
  <span class="bkly-ref-scope-tag">pocket.update</span>
</div>
[block:callout]
{
  "type": "info",
  "title": "Nota",
  "body": "Para mais informações, confira a documentação [Alteração do usuário](/docs/alteracao-usuario)."
}
[/block]

## Path parameters

- `pocketNumber` string, nullable, required

## Parameters

- `#/paths/~1pockets~1{pocketNumber}/get/parameters/2` (unresolved $ref)
- `#/paths/~1legal-agreements~1file/get/parameters/1` (unresolved $ref)

## Request body

- ChangingUserRequest
  - `data` User
    - `name` string, required: Nome do usuário da conta pocket.
    - `document` Document, required
      - `value` string, nullable: Número do documento do usuário.
      - `type` 'CPF' | 'CNPJ': Tipo do documento do titular da conta.
    - `birthDate` string, date-time, required: Data de nascimento do usuário da conta pocket.
  - `metadata` object, nullable

## Response `200`

Usuário da conta pocket alterado com sucesso.

- ChangingUserResponse
  - `data` ChangingUserResponseData
    - `number` string: Número da conta pocket.
    - `label` string: Nome descritivo da conta pocket.
    - `suffix` string: Sufixo atribuído ao número da pocket. Exemplo: BRL.
    - `currency` string: Sigla da moeda corrente da pocket.
    - `type` string: Tipo da conta com a sigla da moeda. Exemplo: POCKET_BRL.
    - `status` string: Situação da conta pocket, que pode ser: ACTIVE, DORMANT, LOCKED e CLOSED.
    - `reason` string: Motivo da situação da conta pocket. Nesse caso, sempre será HOLDER_REQUEST.
    - `category` string: Categoria da conta.
    - `useCase` string: Especificação da finalidade da pocket, que pode ser: “ACCOUNT_FOR_UNDER_AGE” (Conta para menor de idade), “CORPORATE_EXPENSES” (Despesas corporativas), “FLEXIBLE_BENEFITS” (Benefícios flexíveis) e “BALANCE_SEGREGATION” (Segregação de saldo).
    - `createdAt` string: Data de criação da conta pocket, no formato yyyy-MM-dd'T'HH:mm:ss.SSS.
    - `updateddAt` string: Data de atualizaçã da conta pocket, no formato yyyy-MM-dd'T'HH:mm:ss.SSS.
    - `user` User
      - `name` string, required: Nome do usuário da conta pocket.
      - `document` Document, required
        - `value` string, nullable: Número do documento do usuário.
        - `type` 'CPF' | 'CNPJ': Tipo do documento do titular da conta.
      - `birthDate` string, date-time, required: Data de nascimento do usuário da conta pocket.
    - `account` AccountCompleteResponse
      - `branch` string: Número da agência da conta de pagamento à qual a conta pocket está atrelada.
      - `number` string: Número da conta de pagamento.
      - `status` string: Situação da conta de pagamento que, nesse caso, será “ACTIVE”.
      - `reason` string: Motivo da situação da conta de pagamento.
      - `createdAt` string: Data de criação da conta de pagamento, no formato yyyy-MM-dd'T'HH:mm:ss.SSS.
      - `bank` Bank
        - `ispb` string: ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
        - `code` string: Código do banco.
        - `name` string: Nome do banco.
      - `holder` HolderCompleteResponse
        - `document` Document
          - `value` string, nullable: Número do documento do usuário.
          - `type` 'CPF' | 'CNPJ': Tipo do documento do titular da conta.
        - `type` string: Tipo do cadastro do titular da conta de pagamento (“CUSTOMER” ou “BUSINESS”).
        - `name` string: Nome do titular da conta de pagamento.
        - `status` string: Situação do cadastro do titular.
        - `createdAt` string: Data de criação do cadastro do titular no formato yyyy-MM-dd'T'HH:mm:ss.SSS.
  - `links` Link[], nullable
    - `url` string, nullable: URLs que podem ser utilizadas em um próximo estado da entidade. Nesse caso, trata-se da própria requisição realizada.
    - `rel` string, nullable: Descrição de como a URL se relaciona com o recurso atual.
    - `method` string, nullable: Tipo de verbo que deve ser utilizado para acessar a URL. Nesse caso, é o GET.
  - `metadata` object, nullable

## Other responses

- `400` (unresolved $ref)
- `401` (unresolved $ref)
- `403` (unresolved $ref)
- `404` (unresolved $ref)
- `422` (unresolved $ref)
- `500` (unresolved $ref)
- `503` (unresolved $ref)

---

[API](https://skmtc.dev/bankly/apis/gest-o-de-contas.md) - [All operations](https://skmtc.dev/bankly/apis/gest-o-de-contas/llms.txt) - [OpenAPI document](https://skmtc.dev/bankly/apis/gest-o-de-contas/revisions/39000596dbd3?raw)