Skip to main content

​
Create a Recipient Group

Creates a group to organize recipients for bulk policy assignment. 
POST /v1/docks/:dockId/groups

​
Path Parameters

ParameterTypeDescription
dockIdstringThe dock ID

​
Request Body

ParameterTypeRequiredDescription
namestringRequiredGroup display name
descriptionstringOptionalGroup description
recipientIdsstring[]OptionalInitial member IDs to add

​
Example Request

curl -X POST https://api.docyard.io/v1/docks/dock_01HQ3K.../groups \
  -H "Authorization: Bearer dk_live_a1b2c3d4..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Mortgagee Partners",
    "description": "All institutional mortgage lender recipients",
    "recipientIds": ["rcp_01HQ3N...", "rcp_01HQ3P..."]
  }'

​
Response

{
  "id": "grp_01HQ3R...",
  "dockId": "dock_01HQ3K...",
  "name": "Mortgagee Partners",
  "description": "All institutional mortgage lender recipients",
  "createdAt": "2025-01-15T10:40:00.000Z"
}

​
Error Handling

StatusCondition
400name is missing
401Missing or invalid API key
404Dock or referenced recipient not found