Create a folder (optionally with leads in it)

POSThttps://server.heyrik.com/api/v1/crm/folders

Headers

AuthorizationstringRequired

Use Bearer $HEYRIK_API_KEY with an account-scoped API key. Keep the key on your server.

Get your API key

Parameters 3

Fields documented for this operation. See the request example for placement and structure.

namestringRequired

Folder name.

colorstring

Hex colour for the dashboard.

leadIdsarray

Leads to move into it right away.

Response

No response example is documented for this operation yet.

Error reference

POST/crm/folders

cURL

curl -X POST https://server.heyrik.com/api/v1/crm/folders \
  -H "Authorization: Bearer $HEYRIK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Hyderabad - August", "leadIds": ["lead_71a4"] }'

Illustrative examples · No live request is sent