Announcement

A one-way broadcast sent to every user in the organization or to the members of selected chats, either immediately or at a scheduled time. read_at, dismissed_at, sent_count and read_count are relative to the requesting user.

  • attachments
    Type:
    required
    Properties: 8
  • chat_ids
    Type: array of integer
    required

    Chats whose members receive the announcement. Viewer-scoped: the sender and users with the organization's delete_any_announcement permission see every targeted chat; other recipients see only the targeted chats they are currently a member of, so the array can be empty even when organization_wide is false (for example, for a recipient who has since left the chat). Empty when organization_wide is true.

  • created_at
    Type: stringFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • dismissed_at
    Type: string | nullFormat: date-time
    required

    When the calling user dismissed (archived) this announcement, or null. Dismissed announcements are hidden from the list unless filter[dismissed]=true.

  • id
    Type: integer
    required

    Integer numbers.

  • language
    Type: string | null
    required

    Detected language of text, or null when it could not be determined.

  • organization_wide
    Type: boolean
    required

    true when the announcement targets every user in the organization.

  • read_at
    Type: string | nullFormat: date-time
    required

    When the requesting user read the announcement. null if they have not read it or are not a recipient.

  • scheduled_at
    Type: string | nullFormat: date-time
    required

    When the announcement is (or was) scheduled to be sent. null for announcements sent immediately.

  • sent_at
    Type: string | nullFormat: date-time
    required

    When the announcement was sent. null until it has been sent.

  • status
    Type: stringenum
    required

    scheduled until the send time is reached, sending while delivery is in progress, then sent or failed.

    values
    scheduledsendingsentfailed
  • text
    Type: string
    required
  • updated_at
    Type: stringFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • user_id
    Type: integer
    required

    ID of the user who sent (or scheduled) the announcement.

  • read_count
    Type: integer

    Number of recipients who have read the announcement. Only present for the sender and for users with the organization's delete_any_announcement permission.

  • sent_count
    Type: integer

    Number of users the announcement was delivered to. Only present for the sender and for users with the organization's delete_any_announcement permission.

  • translation
    Type: object | null

    The announcement text translated into your language. Only present when requested with include=translation; null when no translation is available.

    Properties: 2
  • user
    Type:

    The user who sent the announcement. Only present when loaded.

    Properties: 22
Previous
Task
Next
Reaction