Skip to main content

​
Update a Recipient Group

Updates the name or description of an existing group. 
PATCH /v1/docks/:dockId/groups/:id

​
Path Parameters

ParameterTypeDescription
dockIdstringThe dock ID
idstringThe group ID

​
Request Body

ParameterTypeRequiredDescription
namestringOptionalUpdated group name
descriptionstringOptionalUpdated description

​
Example Request

curl -X PATCH https://api.docyard.io/v1/docks/dock_01HQ3K.../groups/grp_01HQ3R... \
  -H "Authorization: Bearer dk_live_a1b2c3d4..." \
  -H "Content-Type: application/json" \
  -d '{ "name": "Mortgagee Lenders" }'

​
Response

Returns the full updated group object.

​
Error Handling

StatusCondition
401Missing or invalid API key
404Group or dock not found