Skip to main content

​
Remove Recipients from Group

Removes recipients from a group. The recipients remain in the dock’s catalog — they are only disassociated from this group. 
DELETE /v1/docks/:dockId/groups/:id/recipients

​
Path Parameters

ParameterTypeDescription
dockIdstringThe dock ID
idstringThe group ID

​
Request Body

ParameterTypeRequiredDescription
recipientIdsstring[]RequiredArray of recipient IDs to remove

​
Example Request

curl -X DELETE https://api.docyard.io/v1/docks/dock_01HQ3K.../groups/grp_01HQ3R.../recipients \
  -H "Authorization: Bearer dk_live_a1b2c3d4..." \
  -H "Content-Type: application/json" \
  -d '{ "recipientIds": ["rcp_01HQ3Q..."] }'

​
Response

Returns the updated group with remaining members.

​
Error Handling

StatusCondition
400recipientIds is empty
401Missing or invalid API key
404Group or dock not found