Peer10Developers

API reference / communications

communications

GET/api/v1/communications

List communications

Auth:
required (min role: coach)
Query:
limit, offset, type, status
Response:
{ data }
POST/api/v1/communications

Create communication

Auth:
required (min role: coach)
Request:
{ type, subject, body, recipientType, recipientId, teamId, divisionId, scheduledAt }
Response:
{ data }
POST/api/v1/communications/bulk

Create bulk

Auth:
required (min role: admin)
Response:
{ success, message }
POST/api/v1/communications/changeset

Create changeset

Auth:
required (min role: admin)
Response:
{ data }
POST/api/v1/communications/draft

Create draft

Auth:
required
Response:
{ data }
POST/api/v1/communications/execute

Execute execute

Auth:
required (min role: admin)
Response:
{ success, message }
POST/api/v1/communications/send

Create send

Auth:
required (min role: admin)
Response:
{ success, message }
GET/api/v1/communications/templates

List templates

Auth:
required (min role: admin)
Response:
{ data }
POST/api/v1/communications/templates

Create template

Auth:
required (min role: admin)
Response:
{ data }
GET/api/v1/communications/templates/:id

Get template by ID

Auth:
required (min role: admin)
Response:
{ data }
PUT/api/v1/communications/templates/:id

Update template

Auth:
required (min role: admin)
Response:
{ data }
DELETE/api/v1/communications/templates/:id

Delete template

Auth:
required (min role: admin)
Response:
{ success, message }
communications API — Peer10 Developers