---
title: "PUT /v1/customers/{customer_id}/recipients/{recipient_id}"
method: PUT
path: "/v1/customers/{customer_id}/recipients/{recipient_id}"
tags: ["crate::web::openapi::recipients"]
---

# PUT /v1/customers/{customer_id}/recipients/{recipient_id}

`PUT /v1/customers/{customer_id}/recipients/{recipient_id}`

## Request

- Base URL: `https://api.1money.com`
- URL: `https://api.1money.com/v1/customers/{customer_id}/recipients/{recipient_id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/1money/apis/1money-openapi/docs/v1/customers/:customer_id/recipients/:recipient_id/put.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `customer_id` string, required
- `recipient_id` string, required

## Request body

- UpdateRecipientRequest: Only nickname can be edited. Other fields may be supplied only when equal to their stored values.
  - `business_type` 'INDIVIDUAL' | 'COMPANY'
  - `first_name` string, nullable: First name (for INDIVIDUAL type)
  - `last_name` string, nullable: Last name (for INDIVIDUAL type)
  - `company_name` string, nullable: Company name (for COMPANY type)
  - `nickname` string, nullable: Display name
  - `email` string, nullable: Email address
  - `mobile_code` string, nullable: Mobile country code
  - `mobile_num` string, nullable: Mobile number
  - `relationship` 'EMPLOYEE' | 'CONTRACTOR' | 'VENDOR' | 'SUBSIDIARY' | 'MERCHANT' | 'CUSTOMER' | 'LANDLORD' | 'FAMILY' | 'OTHER' | 'NotSet'
  - `address` RecipientAddress: Recipient address details
    - `country_code` 'AND' | 'ARE' | 'AFG' | 'ATG' | 'AIA' | 'ALB' | 'ARM' | 'AGO' | 'ARG' | 'ASM' | 'AUT' | 'AUS' | 'ABW' | 'AZE' | 'BIH' | 'BRB' | 'BGD' | 'BEL' | 'BFA' | 'BGR' | 'BHR' | 'BDI' | 'BEN' | 'BLM' | 'BMU' | 'BRN' | 'BOL' | 'BES' | 'BRA' | 'BHS' | 'BTN' | 'BWA' | 'BLR' | 'BLZ' | 'CAN' | 'CCK' | 'COD' | 'CAF' | 'COG' | 'CHE' | 'CIV' | 'COK' | 'CHL' | 'CMR' | 'CHN' | 'COL' | 'CRI' | 'CUB' | 'CPV' | 'CUW' | 'CXR' | 'CYP' | 'CZE' | 'DEU' | 'DJI' | 'DNK' | 'DMA' | 'DOM' | 'DZA' | 'ECU' | 'EST' | 'EGY' | 'ESH' | 'ERI' | 'ESP' | 'ETH' | 'FIN' | 'FJI' | 'FLK' | 'FSM' | 'FRO' | 'FRA' | 'GAB' | 'GBR' | 'GRD' | 'GEO' | 'GUF' | 'GGY' | 'GHA' | 'GIB' | 'GRL' | 'GMB' | 'GIN' | 'GLP' | 'GNQ' | 'GRC' | 'SGS' | 'GTM' | 'GUM' | 'GNB' | 'GUY' | 'HKG' | 'HND' | 'HRV' | 'HTI' | 'HUN' | 'IDN' | 'IRL' | 'ISR' | 'IMN' | 'IND' | 'IOT' | 'IRQ' | 'IRN' | 'ISL' | 'ITA' | 'JEY' | 'JAM' | 'JOR' | 'JPN' | 'KEN' | 'KGZ' | 'KHM' | 'KIR' | 'COM' | 'KNA' | 'PRK' | 'KOR' | 'KWT' | 'CYM' | 'KAZ' | 'LAO' | 'LBN' | 'LCA' | 'LIE' | 'LKA' | 'LBR' | 'LSO' | 'LTU' | 'LUX' | 'LVA' | 'LBY' | 'MAR' | 'MCO' | 'MDA' | 'MNE' | 'MAF' | 'MDG' | 'MHL' | 'MKD' | 'MLI' | 'MMR' | 'MNG' | 'MAC' | 'MNP' | 'MTQ' | 'MRT' | 'MSR' | 'MLT' | 'MUS' | 'MDV' | 'MWI' | 'MEX' | 'MYS' | 'MOZ' | 'NAM' | 'NCL' | 'NER' | 'NFK' | 'NGA' | 'NIC' | 'NLD' | 'NOR' | 'NPL' | 'NRU' | 'NIU' | 'NZL' | 'OMN' | 'PAN' | 'PER' | 'PYF' | 'PNG' | 'PHL' | 'PAK' | 'POL' | 'SPM' | 'PCN' | 'PRI' | 'PSE' | 'PRT' | 'PLW' | 'PRY' | 'QAT' | 'REU' | 'ROU' | 'SRB' | 'RUS' | 'RWA' | 'SAU' | 'SLB' | 'SYC' | 'SDN' | 'SWE' | 'SGP' | 'SHN' | 'SVN' | 'SJM' | 'SVK' | 'SLE' | 'SMR' | 'SEN' | 'SOM' | 'SUR' | 'SSD' | 'STP' | 'SLV' | 'SXM' | 'SYR' | 'SWZ' | 'TCA' | 'TCD' | 'TGO' | 'THA' | 'TJK' | 'TKL' | 'TLS' | 'TKM' | 'TUN' | 'TON' | 'TUR' | 'TTO' | 'TUV' | 'TWN' | 'TZA' | 'UKR' | 'UGA' | 'USA' | 'URY' | 'UZB' | 'VAT' | 'VCT' | 'VEN' | 'VGB' | 'VIR' | 'VNM' | 'VUT' | 'WLF' | 'WSM' | 'XKX' | 'YEM' | 'MYT' | 'ZAF' | 'ZMB' | 'ZWE', required: ISO 3166-1 alpha-3 country codes.
    - `address_line1` string, required: Street address line 1
    - `address_line2` string, nullable: Street address line 2 (optional)
    - `city` string, required: City
    - `region` string, nullable: State/region (optional)
    - `postal_code` string, required: Postal code

## Response `200`

Recipient updated successfully

- RecipientResponse: Recipient response object
  - `recipient_id` string, required: Counterparty ID. Empty values are still allowed for legacy DB columns where an empty cpid means the record is not tied to a recipient.
  - `customer_id` string, required: Portfolio ID — also exposed as `customer_id` in OpenAPI. Identifies one individual application / portfolio row within an entity.
  - `business_type` string, required: Recipient type: INDIVIDUAL or COMPANY
  - `full_name` string, required: Full name computed from name fields
  - `nickname` string, nullable: User-defined nickname (optional)
  - `email` string, nullable: Email address (optional)
  - `relationship` string, nullable: Relationship to the customer (optional)
  - `status` string, required: Recipient status. Possible values: success, pending_review, blocked
  - `address` AddressDetails
    - `full_address` string, required
    - `country_code` string, required: ISO 3166-1 alpha-3 three-letter country codes in upper case.
    - `address_line1` string, required: The street number for this address (the whitespaces are trimmed from field).
    - `address_line2` string, nullable: An additional address line for this address (the whitespaces are trimmed from field).
    - `city` string, required: A city for this address (the whitespaces are trimmed from field).
    - `region` string, nullable: The address's region. This is state for U.S., province for Canada (the whitespaces are trimmed from field).
    - `postal_code` string, required: A postal code for this address (the whitespaces are trimmed from field).
  - `action_required` ActionRequired
    - `type` string, required
    - `case_id` string, required: RFI case business ID.
    - `action` string, required
  - `created_at` string, date-time, required: Created timestamp
  - `modified_at` string, date-time, required: Last modified timestamp

## Other responses

- `400`: Validation failed - Invalid request body
- `401`: Authentication failed
- `404`: Recipient not found
- `405`: Method not allowed
- `500`: Internal server error

## Changes

- **2026-11-03** `d213edbaccb6`: 4 breaking, 11 warning, 6 info
  - removed the enum value `Unknown` of the request property `relationship/oneOf[#/components/schemas/RecipientRelation]/`
  - the `address/oneOf[#/components/schemas/RecipientAddress]/address_line1` request property's minLength was increased from `0` to `1`
  - the `address/oneOf[#/components/schemas/RecipientAddress]/city` request property's minLength was increased from `0` to `1`
  - the `address/oneOf[#/components/schemas/RecipientAddress]/postal_code` request property's minLength was increased from `0` to `1`
  - …17 more

[Operation history](https://skmtc.dev/1money/apis/1money-openapi/changes/v1/customers/:customer_id/recipients/:recipient_id/put.md)

---

[API](https://skmtc.dev/1money/apis/1money-openapi.md) - [All operations](https://skmtc.dev/1money/apis/1money-openapi/llms.txt) - [OpenAPI document](https://skmtc.dev/1money/apis/1money-openapi/revisions/d213edbaccb6?raw)
