API reference
Workspace
The workspace itself.
GET/workspace
List workspace
Needs the permission tenant:read.
curl -X GET https://crm.anibrosdesign.com/api/v1/workspace \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 401 403 429
PATCH/workspace
Change a workspace
Needs the permission tenant:update.
| Body field | Type | Notes |
|---|---|---|
name | string | at least 1 characters. up to 120 characters |
timezone | string | at least 3 characters. up to 64 characters |
currency | string | |
defaultCountry | string or null | |
leadAssignment | one of creator, balanced, unassigned | |
firstResponseMinutes | integer | at least 0. up to 10080 |
routing | list of object | up to 9 items |
routing[].source required | one of website, referral, portal, direct, meta_ads, google_ads, walk_in, other, all | |
routing[].userIds required | list of string (uuid) | at least 1 items. up to 20 items |
primaryColor | string or null | |
accentColor | string or null |
curl -X PATCH https://crm.anibrosdesign.com/api/v1/workspace \
-H "Authorization: Bearer crm_live_xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"name":"text","timezone":"text","currency":"text"}'Responses:
200 400 401 402 403 412 429
Something missing or unclear? Tell us.