Placewise API
Get startedExplore
Get startedExplore
Performance Cloud 🗗
Placewise 🗗
ExplorePublic APIManagement APIUsers API
Operations APIMessaging APIReporting APIML APIData API
ExplorePublic APIManagement APIUsers API
Operations APIMessaging APIReporting APIML APIData API
  1. Conversations
  • Introduction
  • Users
    • Introduction
    • Account
      • Show Notifications Settings
      • Update Notifications Settings
    • List Users
      GET
  • Conversations
    • Introduction
    • Conversations
      • Mark Conversation as "received"
      • Create Conversation
      • List Conversations
      • Show Conversation
      • Mark Conversation as "seen"
      • Archive Conversation
    • Messages
      • Create Message
      • List Messages
      • Archive Message
  • Notifications
    • List Notifications
      GET
    • Show Notification
      GET
    • Mark all Notifications as Received
      PUT
    • Mark Notification as Seen
      PUT
    • Mark all Notifications as Seen
      PUT
    • Mark Notification as Received
      PUT
  • Subunits Scopes
    • List Subunits Scopes for User
      GET
  1. Conversations

Introduction

User conversations access#

The user can access Conversations
(and Message within them) that user participates in, in other words those that:
are authored by him
are sent to audience_ids that user belongs to
are sent to user_ids that contain user's ID

Conversation model#

Example#

{
  "conversation": {
    "id": 1,
    "author_id": "7db2c508-1758-4b84-bb68-50b5c8e1f458",
    "audience_ids": [15],
    "unseen_messages_count": 0,
    "user_ids": ["7d503e59-18f2-4028-95fc-177fa25820c8"],
    "created_at": "2022-05-10T09:01:27.415094Z",
    "updated_at": "2022-05-10T09:01:27.415094Z"
  }
}

Definition#

KeyTypeReadonly?Mandatory?Description
idintegeryesyes
author_idUUIDyesyesIDs of user that started the conversation
audience_idsinteger[]nono1Audience which members are participants of the conversation
unseen_messages_countintegeryesnocount of user unseen messages in the conversation
user_idsUUID[]nono1IDs of users which are participants of the conversation
created_atdatetimeyesyesTime of creation
updated_atdatetimeyesyesTime of last update
1 At least one is required

Message model#

Example#

{
  "id": 3,
  "author_id": "7db2c508-1758-4b84-bb68-50b5c8e1f458",
  "content": "Hello *there*",
  "seen": true,
  "created_at": "2022-05-10T09:42:15.861021Z",
  "updated_at": "2022-05-10T09:42:15.861021Z"
}

Definition#

KeyTypeReadonly?Mandatory?Description
idintegeryesyes
author_idUUIDyesyesID of user that sent the message
contentstringnoyes
seenbooleanyesnoStates whether the user has seen this message
created_atdatetimeyesyesTime of creation
updated_atdatetimeyesyesTime of last update
Previous
List Users
Next
Mark Conversation as "received"
Built with