Communication

Messages themselves aren't available through the API, to protect staff privacy.

For how this area works day to day, see the Communication guide.

Webhook events: announcement.published, notification.requested Planned. See Webhooks.

All paths are relative to /api/v1. Key is the scope an integration key needs, People the permission a signed-in person or personal key needs, and Feature the feature switch the endpoint belongs to. See how to read this reference.

• GET/announcements

  List announcements

  Keycommunication:read

  Peopleanyone

  Featurecommunication.announcements
• POST/announcements

  Create an announcement

  Keycommunication:write

  Peopleannouncements.send

  Featurecommunication.announcements
• GET/announcements/{id}

  Get an announcement

  Keycommunication:read

  Peopleanyone

  Featurecommunication.announcements
• PATCH/announcements/{id}

  Update an announcement (partial)

  Keycommunication:write

  Peopleannouncements.send

  Featurecommunication.announcements
• DELETE/announcements/{id}

  Archive an announcement

  Keycommunication:write

  Peopleannouncements.send

  Featurecommunication.announcements
• GET/announcements/{id}/acknowledgments

  Who has acknowledged an announcement

  Keycommunication:read

  Peopleannouncements.send

  Featurecommunication.announcements
• POST/announcements/{id}:acknowledge

  Record that an employee read an announcement

  Keycommunication:write

  Peopleannouncements.send

  Featurecommunication.announcements
• GET/calendar-events

  List calendar events

  Keycommunication:read

  Peopleanyone

  Featurecommunication.calendar
• POST/calendar-events

  Create a calendar event

  Keycommunication:write

  Peoplecalendar.manage

  Featurecommunication.calendar
• GET/calendar-events/external/{externalId}

  Get a calendar event by external ID

  Keycommunication:read

  Peopleanyone

  Featurecommunication.calendar
• PUT/calendar-events/external/{externalId}

  Create or replace a calendar event by external ID

  Keycommunication:write

  Peoplecalendar.manage

  Featurecommunication.calendar
• GET/calendar-events/{id}

  Get a calendar event

  Keycommunication:read

  Peopleanyone

  Featurecommunication.calendar
• PATCH/calendar-events/{id}

  Update a calendar event (partial)

  Keycommunication:write

  Peoplecalendar.manage

  Featurecommunication.calendar
• DELETE/calendar-events/{id}

  Archive a calendar event

  Keycommunication:write

  Peoplecalendar.manage

  Featurecommunication.calendar