Skip to main content

​
Add Recipients to Group

Adds recipients to a group. Recipients inherit any policies assigned to the group. 
POST /v1/docks/:dockId/groups/:id/recipients

​
Path Parameters

ParameterTypeDescription
dockIdstringThe dock ID
idstringThe group ID

​
Request Body

ParameterTypeRequiredDescription
recipientIdsstring[]RequiredArray of recipient IDs to add

​
Example Request

curl -X POST 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...", "rcp_01HQ3S..."] }'

​
Response

Returns the updated group with all current members.

​
Error Handling

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