---
title: "Update Consumer"
method: PUT
path: "/api/v2/consumers/{consumer_id}"
tags: ["Consumers"]
---

# Update Consumer

`PUT /api/v2/consumers/{consumer_id}`

Update consumer information such as contact details or payment methods.

## Path parameters

- `consumer_id` string, uuid, required — Unique identifier (UUID) of the consumer to update

## Request body

- ConsumerUpdate — Consumer update model with all fields optional.
  - `name` string, nullable — Consumer name
  - `phone_number` string, phone, nullable — Phone number
  - `email` string, email, nullable — Email address
  - `external_id` string, nullable — External ID
  - `iban` string, nullable — IBAN
  - `alias` string, nullable — Alias
  - `comment` string, nullable — Comment
  - `preferred_language` 'AR' | 'EN'
  - `communication_methods` ConsumerCommunicationMethod[], nullable — Communication methods
  - `consumer_type` 'INDIVIDUAL' | 'BUSINESS'
  - `address` AddressCreate — Address creation model for B2B consumers.
    - `address_line_1` string, required — Address line 1 (building number, street name)
    - `address_line_2` string, nullable — Address line 2 (district)
    - `city` string, required — City
    - `postal_code` string, nullable — Postal code
    - `country` string, required — Country
  - `vat_number` string, nullable — VAT number (optional for business type)
  - `commercial_registration` string, nullable — Commercial registration number (optional for business type)
  - `beneficiaries` BeneficiaryUpdate[], nullable — List of beneficiaries (optional)
    - `id` string, uuid, nullable — Beneficiary to update
    - `name` string, required — New name for the beneficiary
    - `fields` object, nullable — When set, replaces all catalog field values for this associated entity
    - `delete` boolean — Whether to delete the beneficiary
  - `external_metadata` ExternalMetadataStorage

## Response `200`

Successful Response

- BaseConsumerResponse
  - `id` string, uuid4 — Unique identifier (UUID) of the organization consumer
  - `name` string — Name of the consumer
  - `phone_number` string, phone, nullable — Phone number of the consumer
  - `email` string, email, nullable — Email address of the consumer
  - `external_id` string, nullable — External identifier for the consumer
  - `consumer` AppConsumerV2DtosConsumer
    - `id` string, uuid4, nullable — Unique identifier (UUID) of the consumer
    - `phone_number` string, phone, nullable — Phone number of the consumer
    - `preferred_language` 'AR' | 'EN'
  - `iban` string, nullable — IBAN (International Bank Account Number) of the consumer
  - `is_deleted` boolean — Whether the consumer has been deleted
  - `alias` string, nullable — Alias of the consumer
  - `created_at` string, date-time — Date and time when the consumer was created
  - `branch` Branch
    - `id` string, uuid4 — Unique identifier (UUID) of the branch
    - `name` string — Name of the branch
  - `comment` string, nullable — Additional comments or notes about the consumer
  - `communication_methods` ConsumerCommunicationMethod[] — Preferred communication methods for the consumer
  - `preferred_language` 'AR' | 'EN'
  - `consumer_type` 'INDIVIDUAL' | 'BUSINESS'
  - `address` AddressResponse — Address response model.
    - `address_line_1` string — Address line 1
    - `address_line_2` string, nullable — Address line 2
    - `city` string — City
    - `postal_code` string, nullable — Postal code
    - `country` string — Country
  - `vat_number` string, nullable — VAT number (optional for business type)
  - `commercial_registration` string, nullable — Commercial registration number (optional for business type)
  - `external_metadata` ExternalMetadataStorage
  - `beneficiaries` Beneficiary[] — List of beneficiaries
    - `id` string, uuid4 — Unique identifier (UUID) of the beneficiary
    - `name` string — Name of the beneficiary
    - `fields` object — Catalog field values for this associated entity

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/streampay/apis/stream-app.md) · [All operations](https://skmtc.dev/streampay/apis/stream-app/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/streampay/stream-app/revisions/515eeea7d260/schema)