> ## Documentation Index > Fetch the complete documentation index at: https://docs.swipelux.com/llms.txt > Use this file to discover all available pages before exploring further. # Update recipient > Updates the supplied fields on an active recipient. Archive is terminal; archived recipients reject later updates. ## OpenAPI ````yaml /openapi.json patch /v3/customers/{customerId}/recipients/{recipientId} openapi: 3.1.0 info: title: Swipelux API version: 3.1.0 servers: - url: https://platform.swipelux.com description: Production and sandbox; environment selected by API key security: - apiKey: [] tags: - name: customers x-displayName: Customers description: >- Create, list, update, export, and archive individual and business customers and their related parties. - name: capabilities x-displayName: Capabilities description: >- Discover, request, inspect, and cancel customer capabilities and their institution applications. - name: accounts x-displayName: Accounts description: Create, inspect, update, and archive customer accounts. - name: recipients x-displayName: Recipients description: Create third-party recipients and their payout destinations. - name: Tasks x-displayName: Tasks description: Inspect customer, capability, application, account, and transfer tasks. - name: Task submissions x-displayName: Task submissions description: Submit and inspect immutable answers to customer tasks. - name: documents x-displayName: Documents description: Upload and inspect customer documents used in task submissions. - name: money-movement x-displayName: Money movement description: Create quotes, execute quote-backed transfers, and inspect transfer state. - name: rules x-displayName: Rules description: >- Standing instructions that act on incoming funds. A rule watches a custodial wallet account (`trigger`) and, when funds become available on it, transfers them to a target (`action`) — most commonly a sweep to a non-custodial wallet destination. Rules match at the account credit, not at the deposit rail: fiat deposits settle into the issued bank account's settlement wallet account, so a rule on that wallet account catches ACH/SEPA/SWIFT deposits, stablecoin deposits, and internal transfers alike. The action target reuses the money-movement vocabulary (`account` for the customer's own accounts, `destination` for recipient destinations). At most one non-archived rule may watch a given trigger account. Statuses: `active ⇄ paused → archived` — pause and resume through PATCH, archive (terminal) through DELETE. - name: sandbox x-displayName: Sandbox description: Simulate supported account, task, capability, and transfer outcomes. - name: institutions x-displayName: Institutions description: List institutions referenced by capabilities and applications. - name: webhooks x-displayName: Webhooks description: Configure webhook endpoints and inspect delivery activity. externalDocs: description: Swipelux Documentation url: https://docs.swipelux.com paths: /v3/customers/{customerId}/recipients/{recipientId}: patch: tags: - recipients summary: Update recipient description: >- Updates the supplied fields on an active recipient. Archive is terminal; archived recipients reject later updates. operationId: patchV3CustomersByCustomerIdRecipientsByRecipientId parameters: - name: Idempotency-Key in: header required: true schema: type: string minLength: 1 maxLength: 255 example: idem_20260626_0001 description: >- Required for effectful v3 requests (POST, PATCH, PUT, DELETE). Reuse the same key with the same body to replay the cached response. - schema: type: string in: path name: customerId required: true - in: path name: recipientId schema: type: string required: true requestBody: required: true content: application/json: schema: type: object required: [] additionalProperties: false properties: relationship: type: string enum: - employee - contractor - vendor - subsidiary - merchant - customer - landlord - family - other firstName: type: string minLength: 1 lastName: type: string minLength: 1 companyName: type: string minLength: 1 businessIndustry: type: string minLength: 6 maxLength: 6 pattern: ^\d{6}$ description: >- 6-digit NAICS code used for provider-backed ACH readiness checks on business recipients. email: type: string format: email phone: type: string address: type: object required: - streetLine1 - city - postalCode - country additionalProperties: false properties: streetLine1: type: string minLength: 1 streetLine2: type: string city: type: string minLength: 1 state: type: string postalCode: type: string minLength: 1 country: type: string minLength: 2 maxLength: 2 label: type: string maxLength: 255 metadata: type: object additionalProperties: oneOf: - type: string - type: number - type: boolean examples: email: value: email: jason.treasury@swipelux.com label: Treasury payout profile responses: '200': description: Recipient updated headers: Idempotency-Replayed: description: >- Present with value `true` when an idempotent request is replayed. schema: type: string enum: - 'true' content: application/json: schema: type: object properties: data: anyOf: - type: object properties: id: type: string customerId: type: string relationship: enum: - employee - contractor - vendor - subsidiary - merchant - customer - landlord - family - other externalId: type: string status: enum: - active - rejected - archived description: >- Recipient status. Closed enum — active is usable, rejected means a provider rejected the recipient, and archived is no longer usable; additions would be a breaking change. email: type: string phone: type: string address: type: object required: - streetLine1 - city - postalCode - country additionalProperties: false properties: streetLine1: type: string streetLine2: type: string city: type: string state: type: string postalCode: type: string country: type: string label: type: string metadata: type: object additionalProperties: {} createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true description: >- Archive timestamp set by DELETE; null while the recipient is active. type: enum: - individual firstName: type: string lastName: type: string required: - id - customerId - relationship - status - createdAt - updatedAt - archivedAt - type - firstName - lastName additionalProperties: false - type: object properties: id: type: string customerId: type: string relationship: enum: - employee - contractor - vendor - subsidiary - merchant - customer - landlord - family - other externalId: type: string status: enum: - active - rejected - archived description: >- Recipient status. Closed enum — active is usable, rejected means a provider rejected the recipient, and archived is no longer usable; additions would be a breaking change. email: type: string phone: type: string address: type: object required: - streetLine1 - city - postalCode - country additionalProperties: false properties: streetLine1: type: string streetLine2: type: string city: type: string state: type: string postalCode: type: string country: type: string label: type: string metadata: type: object additionalProperties: {} createdAt: type: string updatedAt: type: string archivedAt: type: string nullable: true description: >- Archive timestamp set by DELETE; null while the recipient is active. type: enum: - business companyName: type: string businessIndustry: type: string description: >- 6-digit NAICS code used for provider-backed ACH readiness checks on business recipients. required: - id - customerId - relationship - status - createdAt - updatedAt - archivedAt - type - companyName additionalProperties: false required: - data additionalProperties: false examples: updated: value: data: id: rcp_6dV8xN2pQ4rT7mA9sL1k customerId: cus_uPlL04SqhMf8QYHcJV status: active type: individual relationship: contractor firstName: Jason lastName: Swipelux email: jason.treasury@swipelux.com phone: '+14155551234' address: streetLine1: 1 Market Street city: San Francisco state: CA postalCode: '94105' country: US label: Treasury payout profile createdAt: '2026-06-25T12:00:00.000Z' updatedAt: '2026-06-25T12:05:00.000Z' archivedAt: null '400': description: Invalid request. content: application/problem+json: schema: type: object additionalProperties: false required: - type - title - status - code - detail - correlationId properties: type: type: string format: uri description: Documentation URL for this stable problem code. title: type: string description: Short human-readable problem title. status: type: integer minimum: 400 maximum: 599 description: HTTP status code. code: type: string description: Stable snake_case error code. detail: type: string description: Actionable problem detail for legitimate callers. correlationId: type: string description: Request correlation id. Mirrors `X-Request-Id`. transferId: type: string description: >- Existing transfer that consumed the quote. Present on `quote_already_executed`. retryable: type: boolean description: Whether retrying the same request may succeed. errors: type: array description: Field-level validation errors. items: type: object additionalProperties: false required: - pointer - code - message properties: pointer: type: string description: JSON Pointer into the request body. code: type: string description: Machine-readable field error code. message: type: string description: Human-readable field error message. statusReason: type: object description: >- Structured reason for a state conflict when the failed operation depends on the resource's current status. required: - code - message - actor - retryable properties: code: type: string description: >- Stable snake_case reason code from the documented catalog. example: sanctions_screening_failed message: type: string description: Human-readable explanation of the current status. actor: type: string enum: - customer - developer - provider - network - swipelux description: >- Party whose action moves the resource forward: the end customer, the developer integrating the API, the underlying provider, payment network or rail, or Swipelux. Closed enum — exhaustive; additions would be a breaking change. retryable: type: boolean description: >- Whether retrying the blocked operation without changing its inputs or state may succeed. reviewAnswer: type: string nullable: true description: Verification review answer when supplied by the verifier. capabilities: type: array minItems: 1 items: type: string description: Capability ids that satisfy the failed operation. blockingResources: type: array minItems: 1 description: >- Customer resources that must be resolved before the requested operation can proceed, sorted by type and id. items: type: object additionalProperties: false required: - type - id - requiredAction properties: type: type: string enum: - account - transfer id: type: string description: Public id of the blocking resource. requiredAction: type: string enum: - archive_account - cancel_transfer - wait_for_transfer - resolve_transfer description: Next action required before retrying the operation. '401': description: Authentication required. content: application/problem+json: schema: type: object additionalProperties: false required: - type - title - status - code - detail - correlationId properties: type: type: string format: uri description: Documentation URL for this stable problem code. title: type: string description: Short human-readable problem title. status: type: integer minimum: 400 maximum: 599 description: HTTP status code. code: type: string description: Stable snake_case error code. detail: type: string description: Actionable problem detail for legitimate callers. correlationId: type: string description: Request correlation id. Mirrors `X-Request-Id`. transferId: type: string description: >- Existing transfer that consumed the quote. Present on `quote_already_executed`. retryable: type: boolean description: Whether retrying the same request may succeed. errors: type: array description: Field-level validation errors. items: type: object additionalProperties: false required: - pointer - code - message properties: pointer: type: string description: JSON Pointer into the request body. code: type: string description: Machine-readable field error code. message: type: string description: Human-readable field error message. statusReason: type: object description: >- Structured reason for a state conflict when the failed operation depends on the resource's current status. required: - code - message - actor - retryable properties: code: type: string description: >- Stable snake_case reason code from the documented catalog. example: sanctions_screening_failed message: type: string description: Human-readable explanation of the current status. actor: type: string enum: - customer - developer - provider - network - swipelux description: >- Party whose action moves the resource forward: the end customer, the developer integrating the API, the underlying provider, payment network or rail, or Swipelux. Closed enum — exhaustive; additions would be a breaking change. retryable: type: boolean description: >- Whether retrying the blocked operation without changing its inputs or state may succeed. reviewAnswer: type: string nullable: true description: Verification review answer when supplied by the verifier. capabilities: type: array minItems: 1 items: type: string description: Capability ids that satisfy the failed operation. blockingResources: type: array minItems: 1 description: >- Customer resources that must be resolved before the requested operation can proceed, sorted by type and id. items: type: object additionalProperties: false required: - type - id - requiredAction properties: type: type: string enum: - account - transfer id: type: string description: Public id of the blocking resource. requiredAction: type: string enum: - archive_account - cancel_transfer - wait_for_transfer - resolve_transfer description: Next action required before retrying the operation. '403': description: Insufficient permissions. content: application/problem+json: schema: type: object additionalProperties: false required: - type - title - status - code - detail - correlationId properties: type: type: string format: uri description: Documentation URL for this stable problem code. title: type: string description: Short human-readable problem title. status: type: integer minimum: 400 maximum: 599 description: HTTP status code. code: type: string description: Stable snake_case error code. detail: type: string description: Actionable problem detail for legitimate callers. correlationId: type: string description: Request correlation id. Mirrors `X-Request-Id`. transferId: type: string description: >- Existing transfer that consumed the quote. Present on `quote_already_executed`. retryable: type: boolean description: Whether retrying the same request may succeed. errors: type: array description: Field-level validation errors. items: type: object additionalProperties: false required: - pointer - code - message properties: pointer: type: string description: JSON Pointer into the request body. code: type: string description: Machine-readable field error code. message: type: string description: Human-readable field error message. statusReason: type: object description: >- Structured reason for a state conflict when the failed operation depends on the resource's current status. required: - code - message - actor - retryable properties: code: type: string description: >- Stable snake_case reason code from the documented catalog. example: sanctions_screening_failed message: type: string description: Human-readable explanation of the current status. actor: type: string enum: - customer - developer - provider - network - swipelux description: >- Party whose action moves the resource forward: the end customer, the developer integrating the API, the underlying provider, payment network or rail, or Swipelux. Closed enum — exhaustive; additions would be a breaking change. retryable: type: boolean description: >- Whether retrying the blocked operation without changing its inputs or state may succeed. reviewAnswer: type: string nullable: true description: Verification review answer when supplied by the verifier. capabilities: type: array minItems: 1 items: type: string description: Capability ids that satisfy the failed operation. blockingResources: type: array minItems: 1 description: >- Customer resources that must be resolved before the requested operation can proceed, sorted by type and id. items: type: object additionalProperties: false required: - type - id - requiredAction properties: type: type: string enum: - account - transfer id: type: string description: Public id of the blocking resource. requiredAction: type: string enum: - archive_account - cancel_transfer - wait_for_transfer - resolve_transfer description: Next action required before retrying the operation. '404': description: Resource not found. content: application/problem+json: schema: type: object additionalProperties: false required: - type - title - status - code - detail - correlationId properties: type: type: string format: uri description: Documentation URL for this stable problem code. title: type: string description: Short human-readable problem title. status: type: integer minimum: 400 maximum: 599 description: HTTP status code. code: type: string description: Stable snake_case error code. detail: type: string description: Actionable problem detail for legitimate callers. correlationId: type: string description: Request correlation id. Mirrors `X-Request-Id`. transferId: type: string description: >- Existing transfer that consumed the quote. Present on `quote_already_executed`. retryable: type: boolean description: Whether retrying the same request may succeed. errors: type: array description: Field-level validation errors. items: type: object additionalProperties: false required: - pointer - code - message properties: pointer: type: string description: JSON Pointer into the request body. code: type: string description: Machine-readable field error code. message: type: string description: Human-readable field error message. statusReason: type: object description: >- Structured reason for a state conflict when the failed operation depends on the resource's current status. required: - code - message - actor - retryable properties: code: type: string description: >- Stable snake_case reason code from the documented catalog. example: sanctions_screening_failed message: type: string description: Human-readable explanation of the current status. actor: type: string enum: - customer - developer - provider - network - swipelux description: >- Party whose action moves the resource forward: the end customer, the developer integrating the API, the underlying provider, payment network or rail, or Swipelux. Closed enum — exhaustive; additions would be a breaking change. retryable: type: boolean description: >- Whether retrying the blocked operation without changing its inputs or state may succeed. reviewAnswer: type: string nullable: true description: Verification review answer when supplied by the verifier. capabilities: type: array minItems: 1 items: type: string description: Capability ids that satisfy the failed operation. blockingResources: type: array minItems: 1 description: >- Customer resources that must be resolved before the requested operation can proceed, sorted by type and id. items: type: object additionalProperties: false required: - type - id - requiredAction properties: type: type: string enum: - account - transfer id: type: string description: Public id of the blocking resource. requiredAction: type: string enum: - archive_account - cancel_transfer - wait_for_transfer - resolve_transfer description: Next action required before retrying the operation. '500': description: Internal server error. content: application/problem+json: schema: type: object additionalProperties: false required: - type - title - status - code - detail - correlationId properties: type: type: string format: uri description: Documentation URL for this stable problem code. title: type: string description: Short human-readable problem title. status: type: integer minimum: 400 maximum: 599 description: HTTP status code. code: type: string description: Stable snake_case error code. detail: type: string description: Actionable problem detail for legitimate callers. correlationId: type: string description: Request correlation id. Mirrors `X-Request-Id`. transferId: type: string description: >- Existing transfer that consumed the quote. Present on `quote_already_executed`. retryable: type: boolean description: Whether retrying the same request may succeed. errors: type: array description: Field-level validation errors. items: type: object additionalProperties: false required: - pointer - code - message properties: pointer: type: string description: JSON Pointer into the request body. code: type: string description: Machine-readable field error code. message: type: string description: Human-readable field error message. statusReason: type: object description: >- Structured reason for a state conflict when the failed operation depends on the resource's current status. required: - code - message - actor - retryable properties: code: type: string description: >- Stable snake_case reason code from the documented catalog. example: sanctions_screening_failed message: type: string description: Human-readable explanation of the current status. actor: type: string enum: - customer - developer - provider - network - swipelux description: >- Party whose action moves the resource forward: the end customer, the developer integrating the API, the underlying provider, payment network or rail, or Swipelux. Closed enum — exhaustive; additions would be a breaking change. retryable: type: boolean description: >- Whether retrying the blocked operation without changing its inputs or state may succeed. reviewAnswer: type: string nullable: true description: Verification review answer when supplied by the verifier. capabilities: type: array minItems: 1 items: type: string description: Capability ids that satisfy the failed operation. blockingResources: type: array minItems: 1 description: >- Customer resources that must be resolved before the requested operation can proceed, sorted by type and id. items: type: object additionalProperties: false required: - type - id - requiredAction properties: type: type: string enum: - account - transfer id: type: string description: Public id of the blocking resource. requiredAction: type: string enum: - archive_account - cancel_transfer - wait_for_transfer - resolve_transfer description: Next action required before retrying the operation. components: securitySchemes: apiKey: type: apiKey in: header name: X-API-Key description: Your Swipelux API key. Obtain this from the Swipelux Dashboard. ```` ## Related topics - [Update account](/api-reference/accounts/patch-v3-customers-by-customer-id-accounts-by-account-id.md) - [Update rule](/api-reference/rules/patch-v3-customers-by-customer-id-rules-by-rule-id.md) - [Update customer](/api-reference/customers/patch-v3-customers-by-customer-id.md) - [Update webhook endpoint](/api-reference/webhooks/patch-v3-webhooks-by-webhook-id.md) - [Update related party](/api-reference/customers/patch-v3-customers-by-customer-id-related-parties-by-related-party-id.md)