--- updatedAt: 2026-04-21T09:29:18.000Z agentTools: projectIndex: https://partner.getpliant.com/llms.txt --- # Update Beneficiary Update an existing beneficiary. You can modify the beneficiary's information including address details, contact information, and display name. # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "contact": { "name": "API Support", "email": "support@getpliant.com", "url": "https://www.getpliant.com" }, "title": "Pliant Partner API", "description": "Pliant Partner API", "version": "2.1.0", "license": { "name": "MIT", "url": "https://opensource.org/license/MIT" } }, "servers": [ { "url": "https://partner-api.getpliant.com/api", "description": "Pliant Production Server" }, { "url": "https://sandbox.partner-api.getpliant.com/api", "description": "Pliant Sandbox Server" }, { "url": "https://pci-api.getpliant.com", "description": "PCI Vault Production Server" }, { "url": "https://pci-sandbox.partner-api.getpliant.com", "description": "PCI Vault Sandbox Server" } ], "x-readme": { "explorer-enabled": false, "samples-languages": [ "curl", "java", "kotlin" ], "headers": [ { "key": "Pliant-API-Version", "value": "2.1.0" } ] }, "tags": [ { "name": "Beneficiaries", "description": "This tag is for operations related to beneficiaries" } ], "paths": { "/beneficiaries/{beneficiaryId}": { "put": { "summary": "Update Beneficiary", "description": "Update an existing beneficiary. You can modify the beneficiary's information including address details, contact information, and display name.\n", "tags": [ "Beneficiaries" ], "operationId": "update-beneficiary", "parameters": [ { "name": "beneficiaryId", "in": "path", "description": "The unique identifier of the beneficiary.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "BUSINESS", "INDIVIDUAL" ], "description": "The type of the beneficiary. It can be one of the following values:\n- `BUSINESS`: A business entity beneficiary.\n- `INDIVIDUAL`: An individual person beneficiary.\n" }, "legalName": { "type": "string", "description": "The legal name of the beneficiary." }, "displayName": { "type": "string", "description": "The display name of the beneficiary." }, "email": { "type": "string", "format": "email", "description": "The email address of the beneficiary." }, "street": { "type": "string", "description": "The street address of the beneficiary." }, "postalCode": { "type": "string", "description": "The postal code of the beneficiary's address." }, "city": { "type": "string", "description": "The city of the beneficiary's address." }, "region": { "type": "string", "description": "The region or state of the beneficiary's address." }, "country": { "type": "string", "description": "The country of the beneficiary's address in ISO 3166-1 alpha-2 format (e.g., `DE` for Germany, `US` for United States)." } }, "required": [ "type", "legalName", "street", "postalCode", "city", "country" ] } } } }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Beneficiary" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "409": { "$ref": "#/components/responses/409" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "This API uses oAuth2 with client credentials flow to [obtain the Bearer Token](/docs/authenticated-api-usage).", "bearerFormat": "JWT" } }, "schemas": { "Beneficiary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The unique identifier of the beneficiary." }, "organizationId": { "type": "string", "format": "uuid", "description": "The organization to which the beneficiary belongs." }, "type": { "type": "string", "enum": [ "BUSINESS", "INDIVIDUAL" ], "description": "The type of the beneficiary. It can be one of the following values:\n- `BUSINESS`: A business entity beneficiary.\n- `INDIVIDUAL`: An individual person beneficiary.\n" }, "legalName": { "type": "string", "description": "The legal name of the beneficiary." }, "displayName": { "type": "string", "description": "The display name of the beneficiary." }, "email": { "type": "string", "format": "email", "description": "The email address of the beneficiary." }, "street": { "type": "string", "description": "The street address of the beneficiary." }, "postalCode": { "type": "string", "description": "The postal code of the beneficiary's address." }, "city": { "type": "string", "description": "The city of the beneficiary's address." }, "region": { "type": "string", "description": "The region or state of the beneficiary's address." }, "country": { "type": "string", "description": "The country of the beneficiary's address in ISO 3166-1 alpha-2 format (e.g., `DE` for Germany, `US` for United States)." }, "active": { "type": "boolean", "description": "Whether the beneficiary is active and can be used for transfers." } } }, "Error": { "type": "object", "properties": { "errorCode": { "type": "string", "description": "The error code" }, "exceptionId": { "type": "string", "format": "uuid", "description": "The id of the exception that was thrown" }, "message": { "type": "string", "description": "The cause of the error or further explanations on the error" } } } }, "responses": { "400": { "description": "Bad Request. The API consumer sent a malformed request which could not be processed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized. The API consumer is not authorized to access the requested resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden. The API consumer is not allowed to access the requested resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found. The requested resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. You may retry the call.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Content. The request could not be completed due to contents of the request. The syntax of the request content was correct.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests. The API consumer has sent too many requests in a given amount of time. Please check our [API guidelines](/docs/pliant-api-guidelines#api-rate-limits).", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Detailed description of the error and breached rate limit." } } } } } }, "500": { "description": "Internal Server Error. The request was not completed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "security": [ { "bearerAuth": [] } ] } ```