Skip to main content

​
Update a Recipient

Updates one or more fields on an existing recipient. Only include fields you want to change. 
PATCH /v1/docks/:dockId/recipients/:id

​
Path Parameters

ParameterTypeDescription
dockIdstringThe dock ID
idstringThe recipient ID

​
Request Body

ParameterTypeRequiredDescription
namestringOptionalUpdated display name
emailstringOptionalUpdated email (stored lowercase)
stakeholderClassstringOptionalUpdated classification
identifiersobjectOptionalUpdated custom identifiers

​
Example Request

curl -X PATCH https://api.docyard.io/v1/docks/dock_01HQ3K.../recipients/rcp_01HQ3N... \
  -H "Authorization: Bearer dk_live_a1b2c3d4..." \
  -H "Content-Type: application/json" \
  -d '{
    "identifiers": {
      "lender_id": "LND-4821",
      "account_number": "ACC-99281",
      "branch_code": "BR-CT-01"
    }
  }'

​
Response

Returns the full updated recipient object. 
{
  "id": "rcp_01HQ3N...",
  "dockId": "dock_01HQ3K...",
  "name": "First National Bank",
  "email": "[email protected]",
  "stakeholderClass": "mortgagee",
  "identifiers": {
    "lender_id": "LND-4821",
    "account_number": "ACC-99281",
    "branch_code": "BR-CT-01"
  },
  "createdAt": "2025-01-15T10:32:00.000Z"
}

​
Error Handling

StatusCondition
400email is not a valid email format
401Missing or invalid API key
404Recipient or dock not found