API reference
Push notifications
Notifications on a phone or computer.
GET/push
List push
Needs the permission notifications:read.
curl -X GET https://crm.anibrosdesign.com/api/v1/push \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 401 403 429
PUT/push/clients/{id}
Set clients (push)
Needs the permission notifications:read.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
| Body field | Type | Notes |
|---|---|---|
enabled required | boolean |
curl -X PUT https://crm.anibrosdesign.com/api/v1/push/clients/{id} \
-H "Authorization: Bearer crm_live_xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"enabled":true}'Responses:
200 400 401 402 403 404 412 429
POST/push/subscribe
Subscribe (pushs)
Needs the permission notifications:read.
| Body field | Type | Notes |
|---|---|---|
endpoint required | string | up to 2000 characters |
keys required | object | |
keys.p256dh required | string | at least 60 characters. up to 200 characters |
keys.auth required | string | at least 16 characters. up to 100 characters |
userAgent | string or null |
curl -X POST https://crm.anibrosdesign.com/api/v1/push/subscribe \
-H "Authorization: Bearer crm_live_xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"endpoint":"text","keys":{"p256dh":"text","auth":"text"},"userAgent":"text"}'Responses:
201 400 401 402 403 429
POST/push/test
Test (pushs)
Needs the permission notifications:read.
curl -X POST https://crm.anibrosdesign.com/api/v1/push/test \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 401 402 403 429
POST/push/unsubscribe
Unsubscribe (pushs)
Needs the permission notifications:read.
| Body field | Type | Notes |
|---|---|---|
endpoint required | string | up to 2000 characters |
curl -X POST https://crm.anibrosdesign.com/api/v1/push/unsubscribe \
-H "Authorization: Bearer crm_live_xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"endpoint":"text"}'Responses:
204 400 401 402 403 429
Something missing or unclear? Tell us.