Attributes

org_id
string

The unique identifier of the organization that owns the WhatsApp account.

chat_id
string

The unique identifier of the WhatsApp chat (format: {phone_number}@c.us for individual chats or {group_id}@g.us for groups).

members
object

A map of members in the chat, keyed by WhatsApp ID (format: {phone_number}@c.us).

chat_name
string

The display name of the chat. For groups, this is the group name. For individual chats, this is the contact’s name.

chat_type
string

The type of chat. Can be group, user, or business.

chat_labels
string

Comma-separated labels associated with the chat on Periskope.

org_phone
string

The WhatsApp ID of the organization’s account (format: {phone_number}@c.us).

chat_image
string

The URL of the chat’s profile image.

created_at
string

The ISO 8601 formatted timestamp when the chat was created.

updated_at
string

The ISO 8601 formatted timestamp when the chat was last updated.

The invite link of the chat.

is_muted
boolean

Indicates if notifications for this chat are muted.

is_archived
boolean

Indicates if the chat has been archived.

custom_properties
object

A map of custom properties associated with the chat. Values depend on the property type:

  • dropdown: Selected option from predefined choices
  • text: Text string value
  • date: Date value
group_description
string

The description text for group chats.

closed_at
string

The ISO 8601 formatted timestamp when the chat was closed, if applicable.

is_exited
boolean

Indicates if the organization has left this chat.

label_ids
object

A map of label identifiers associated with the chat, where keys are label IDs and values are booleans.

assigned_to
string

The email address of the user assigned to this chat.

chat_access
object

A map of user access permissions, where keys are email addresses and values are booleans.

common_chats
array

An array of chat IDs that are shared between the organization and the contact.

member_count
number

The total number of participants in the chat.

chat_org_phones
array

An array of organization WhatsApp IDs associated with this chat.

hubspot_metadata
object

Metadata related to HubSpot integration.

info_admins_only
boolean

Indicates if only admins can modify group info.

messages_admins_only
boolean

Indicates if only admins can send messages in the group.

add_members_admins_only
boolean

Indicates if only admins can add new members to the group.