Docs
reference
Mailbox API

Mailbox API

Send/Receive encrypted messaged either W2W or S2W.

Messages are what conversations are made of in Protocol — they are the basic building blocks of your conversations with your Protocol contacts. On this page, we'll dive into the different message endpoints you can use to manage messages programmatically. We'll look at how to query, send, update, and delete messages.

The message model

The message model contains all the information about the messages and attachments you send to your contacts and groups, including how your contacts have reacted to them.

Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier for the message.

  • Name
    conversation_id
    Type
    string
    Description

    Unique identifier for the conversation the message belongs to.

  • Name
    contact
    Type
    object
    Description

    The contact object for the contact who sent the message.

  • Name
    message
    Type
    string
    Description

    The message content.

  • Name
    reactions
    Type
    array
    Description

    An array of reaction objects associated with the message.

  • Name
    attachments
    Type
    array
    Description

    An array of attachment objects associated with the message.

  • Name
    read_at
    Type
    timestamp
    Description

    Timestamp of when the message was read.

  • Name
    created_at
    Type
    timestamp
    Description

    Timestamp of when the message was created.

  • Name
    updated_at
    Type
    timestamp
    Description

    Timestamp of when the message was last updated.

Overview