unipile-messaging

Server path: /unipile-messaging | Type: Application | PCID required: Yes

Tools

Tool	Description
`unipile_messaging_add_reaction`	Add a reaction to a message
`unipile_messaging_delete_chat`	Delete a chat
`unipile_messaging_delete_message`	Delete a message
`unipile_messaging_forward_message`	Forward a message
`unipile_messaging_get_attendee_by_id`	Retrieve an attendee
`unipile_messaging_get_attendee_profile_picture`	Download a chat attendee picture
`unipile_messaging_get_chat`	Retrieve a chat
`unipile_messaging_get_message`	Retrieve a message
`unipile_messaging_get_message_attachment`	Retrieve an attachment from a message
`unipile_messaging_list_all_attendees`	List all attendees
`unipile_messaging_list_all_chats`	List all chats
`unipile_messaging_list_all_messages`	List all messages
`unipile_messaging_list_attendees`	List all attendees from a chat
`unipile_messaging_list_chat_messages`	List all messages from a chat
`unipile_messaging_list_chats_by_attendee`	List all 1to1 chats for a given attendee
`unipile_messaging_list_messages_by_attendee`	List all messages for a given attendee
`unipile_messaging_patch_chat`	Perform an action on a given chat
`unipile_messaging_patch_message`	Edit a message
`unipile_messaging_send_message_in_chat`	Send a message in a chat
`unipile_messaging_start_new_chat`	Start a new chat
`unipile_messaging_sync_chat_history`	Synchronize a conversation from its beginning

unipile_messaging_add_reaction

Add a reaction to a message Parameters:

Parameter	Type	Required	Default	Description
`message_id`	string	Yes	—	The id of the message to react to.
`reaction`	string	Yes	—	The emoji to react with (native emoji, e.g. ).

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "message_id": {
      "type": "string",
      "description": "The id of the message to react to."
    },
    "reaction": {
      "type": "string",
      "description": "The emoji to react with (native emoji, e.g. )."
    }
  },
  "required": [
    "PCID",
    "message_id",
    "reaction"
  ]
}

unipile_messaging_delete_chat

Delete a chat Parameters:

Parameter	Type	Required	Default	Description
`chat_id`	string	Yes	—	The id of the chat to delete.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "chat_id": {
      "type": "string",
      "description": "The id of the chat to delete."
    }
  },
  "required": [
    "PCID",
    "chat_id"
  ]
}

unipile_messaging_delete_message

Delete a message Parameters:

Parameter	Type	Required	Default	Description
`message_id`	string	Yes	—	The id of the message to delete.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "message_id": {
      "type": "string",
      "description": "The id of the message to delete."
    }
  },
  "required": [
    "PCID",
    "message_id"
  ]
}

unipile_messaging_forward_message

Forward a message Parameters:

Parameter	Type	Required	Default	Description
`message_id`	string	Yes	—	The id of the message to forward.
`chat_id`	string	Yes	—	The id of the chat to forward the message to.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "message_id": {
      "type": "string",
      "description": "The id of the message to forward."
    },
    "chat_id": {
      "type": "string",
      "description": "The id of the chat to forward the message to."
    }
  },
  "required": [
    "PCID",
    "message_id",
    "chat_id"
  ]
}

unipile_messaging_get_attendee_by_id

Retrieve an attendee Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	The id of the wanted attendee.
`account_id`	string	No	—	A filter to target items related to a certain account.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The id of the wanted attendee."
    },
    "account_id": {
      "type": "string",
      "description": "A filter to target items related to a certain account."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

unipile_messaging_get_attendee_profile_picture

Download a chat attendee picture Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	The id of the attendee. Use a chat id to get the picture of a group chat.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The id of the attendee. Use a chat id to get the picture of a group chat."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

unipile_messaging_get_chat

Retrieve a chat Parameters:

Parameter	Type	Required	Default	Description
`account_id`	string	No	—	Mandatory if the chat ID is a provider ID.
`chat_id`	string	Yes	—	The Unipile or provider ID of the chat.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "account_id": {
      "type": "string",
      "description": "Mandatory if the chat ID is a provider ID."
    },
    "chat_id": {
      "type": "string",
      "description": "The Unipile or provider ID of the chat."
    }
  },
  "required": [
    "PCID",
    "chat_id"
  ]
}

unipile_messaging_get_message

Retrieve a message Parameters:

Parameter	Type	Required	Default	Description
`message_id`	string	Yes	—	The id of the message to retrieve.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "message_id": {
      "type": "string",
      "description": "The id of the message to retrieve."
    }
  },
  "required": [
    "PCID",
    "message_id"
  ]
}

unipile_messaging_get_message_attachment

Retrieve an attachment from a message Parameters:

Parameter	Type	Required	Default	Description
`attachment_id`	string	Yes	—	The id of the wanted attachment.
`message_id`	string	Yes	—	The id of the message to which the attachment is linked.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "attachment_id": {
      "type": "string",
      "description": "The id of the wanted attachment."
    },
    "message_id": {
      "type": "string",
      "description": "The id of the message to which the attachment is linked."
    }
  },
  "required": [
    "PCID",
    "attachment_id",
    "message_id"
  ]
}

unipile_messaging_list_all_attendees

List all attendees Parameters:

Parameter	Type	Required	Default	Description
`cursor`	string	No	—	A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved.
`limit`	integer	No	—	A limit for the number of items returned in the response. The value can be set between 1 and 250.
`account_id`	string	No	—	A filter to target attendees related to a certain linked account. The id of the account targeted.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved."
    },
    "limit": {
      "type": "integer",
      "description": "A limit for the number of items returned in the response. The value can be set between 1 and 250."
    },
    "account_id": {
      "type": "string",
      "description": "A filter to target attendees related to a certain linked account. The id of the account targeted."
    }
  },
  "required": [
    "PCID"
  ]
}

unipile_messaging_list_all_chats

List all chats Parameters:

Parameter	Type	Required	Default	Description
`unread`	boolean	No	—	Whether you want to get either unread chats only, or read chats only.
`cursor`	string	No	—	A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved.
`before`	string	No	—	A filter to target items created before the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ).
`after`	string	No	—	A filter to target items created after the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ).
`limit`	integer	No	—	A limit for the number of items returned in the response. The value can be set between 1 and 250.
`account_type`	string	No	—	A filter to target items related to a certain provider.
`account_id`	string	No	—	A filter to target items related to a certain account. Can be a comma-separated list of ids.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "unread": {
      "type": "boolean",
      "description": "Whether you want to get either unread chats only, or read chats only."
    },
    "cursor": {
      "type": "string",
      "description": "A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved."
    },
    "before": {
      "type": "string",
      "description": "A filter to target items created before the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ)."
    },
    "after": {
      "type": "string",
      "description": "A filter to target items created after the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ)."
    },
    "limit": {
      "type": "integer",
      "description": "A limit for the number of items returned in the response. The value can be set between 1 and 250."
    },
    "account_type": {
      "type": "string",
      "description": "A filter to target items related to a certain provider.",
      "enum": [
        "WHATSAPP",
        "LINKEDIN",
        "SLACK",
        "TWITTER",
        "MESSENGER",
        "INSTAGRAM",
        "TELEGRAM"
      ]
    },
    "account_id": {
      "type": "string",
      "description": "A filter to target items related to a certain account. Can be a comma-separated list of ids."
    }
  },
  "required": [
    "PCID"
  ]
}

unipile_messaging_list_all_messages

List all messages Parameters:

Parameter	Type	Required	Default	Description
`cursor`	string	No	—	A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved.
`before`	string	No	—	A filter to target items created before the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ).
`after`	string	No	—	A filter to target items created after the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ).
`limit`	integer	No	—	A limit for the number of items returned in the response. The value can be set between 1 and 250.
`sender_id`	string	No	—	A filter to target messages received from a certain sender. The id of the sender targeted.
`account_id`	string	No	—	A filter to target messages received in a certain linked account. The id of the account targeted.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved."
    },
    "before": {
      "type": "string",
      "description": "A filter to target items created before the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ)."
    },
    "after": {
      "type": "string",
      "description": "A filter to target items created after the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ)."
    },
    "limit": {
      "type": "integer",
      "description": "A limit for the number of items returned in the response. The value can be set between 1 and 250."
    },
    "sender_id": {
      "type": "string",
      "description": "A filter to target messages received from a certain sender. The id of the sender targeted."
    },
    "account_id": {
      "type": "string",
      "description": "A filter to target messages received in a certain linked account. The id of the account targeted."
    }
  },
  "required": [
    "PCID"
  ]
}

unipile_messaging_list_attendees

List all attendees from a chat Parameters:

Parameter	Type	Required	Default	Description
`chat_id`	string	Yes	—	The id of the chat related to requested attendees.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "chat_id": {
      "type": "string",
      "description": "The id of the chat related to requested attendees."
    }
  },
  "required": [
    "PCID",
    "chat_id"
  ]
}

unipile_messaging_list_chat_messages

List all messages from a chat Parameters:

Parameter	Type	Required	Default	Description
`cursor`	string	No	—	A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved.
`before`	string	No	—	A filter to target items created before the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ).
`after`	string	No	—	A filter to target items created after the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ).
`limit`	integer	No	—	A limit for the number of items returned in the response. The value can be set between 1 and 250.
`sender_id`	string	No	—	A filter to target messages received from a certain sender. The id of the sender targeted.
`chat_id`	string	Yes	—	The id of the chat related to requested messages.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved."
    },
    "before": {
      "type": "string",
      "description": "A filter to target items created before the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ)."
    },
    "after": {
      "type": "string",
      "description": "A filter to target items created after the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ)."
    },
    "limit": {
      "type": "integer",
      "description": "A limit for the number of items returned in the response. The value can be set between 1 and 250."
    },
    "sender_id": {
      "type": "string",
      "description": "A filter to target messages received from a certain sender. The id of the sender targeted."
    },
    "chat_id": {
      "type": "string",
      "description": "The id of the chat related to requested messages."
    }
  },
  "required": [
    "PCID",
    "chat_id"
  ]
}

unipile_messaging_list_chats_by_attendee

List all 1to1 chats for a given attendee Parameters:

Parameter	Type	Required	Default	Description
`cursor`	string	No	—	A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved.
`before`	string	No	—	A filter to target items created before the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ).
`after`	string	No	—	A filter to target items created after the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ).
`limit`	integer	No	—	A limit for the number of items returned in the response. The value can be set between 1 and 250.
`account_id`	string	No	—	A filter to target items related to a certain account. Can be a comma-separated list of ids.
`attendee_id`	string	Yes	—	The Unipile ID OR provider_id of the attendee. Can be a comma-separated list of multiple ids.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved."
    },
    "before": {
      "type": "string",
      "description": "A filter to target items created before the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ)."
    },
    "after": {
      "type": "string",
      "description": "A filter to target items created after the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ)."
    },
    "limit": {
      "type": "integer",
      "description": "A limit for the number of items returned in the response. The value can be set between 1 and 250."
    },
    "account_id": {
      "type": "string",
      "description": "A filter to target items related to a certain account. Can be a comma-separated list of ids."
    },
    "attendee_id": {
      "type": "string",
      "description": "The Unipile ID OR provider_id of the attendee. Can be a comma-separated list of multiple ids."
    }
  },
  "required": [
    "PCID",
    "attendee_id"
  ]
}

unipile_messaging_list_messages_by_attendee

List all messages for a given attendee Parameters:

Parameter	Type	Required	Default	Description
`cursor`	string	No	—	A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved.
`before`	string	No	—	A filter to target items created before the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ).
`after`	string	No	—	A filter to target items created after the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ).
`limit`	integer	No	—	A limit for the number of items returned in the response. The value can be set between 1 and 250.
`account_id`	string	No	—	A filter to target items related to a certain account. Can be a comma-separated list of ids.
`sender_id`	string	Yes	—	The Unipile ID OR provider_id of the attendee.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved."
    },
    "before": {
      "type": "string",
      "description": "A filter to target items created before the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ)."
    },
    "after": {
      "type": "string",
      "description": "A filter to target items created after the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ)."
    },
    "limit": {
      "type": "integer",
      "description": "A limit for the number of items returned in the response. The value can be set between 1 and 250."
    },
    "account_id": {
      "type": "string",
      "description": "A filter to target items related to a certain account. Can be a comma-separated list of ids."
    },
    "sender_id": {
      "type": "string",
      "description": "The Unipile ID OR provider_id of the attendee."
    }
  },
  "required": [
    "PCID",
    "sender_id"
  ]
}

unipile_messaging_patch_chat

Perform an action on a given chat Parameters:

Parameter	Type	Required	Default	Description
`chat_id`	string	Yes	—	The id of the chat to be patched
`action`	string	No	—	The action to perform on the chat: - `setReadStatus`: (WhatsApp & LinkedIn only) Set the read status of the chat. - `setMuteStatus`: (WhatsApp & LinkedIn only) Set the mute status of the chat. - `setArchiveStatus`: (WhatsApp only) Set the archive status of the chat. - `setPinnedStatus`: (WhatsApp only) Set the pinned status of the chat. - `addParticipant`: (WhatsApp & Telegram only) Add a participant to the group chat. The account owner must have the Add other members permission in the group. Provide the provider ID as value, for example 334455667788@s.whatsapp.net for WhatsApp, or a Telegram user ID, username, or phone number for Telegram. - `removeParticipant`: (WhatsApp & Telegram only) Remove a participant from the group chat. Provide the provider ID as value, for example 334455667788@s.whatsapp.net for WhatsApp, or a Telegram user ID, username, or phone number for Telegram. - `setLabel`: (WhatsApp only) Add a label to the chat. If the label does not exist, it will be created and then assigned. - `getInviteLink`: (WhatsApp & Telegram only) Generate or retrieve the full group invite link. The account owner must have the required invite permissions in the group.
`value`	object	No	—	Required for every action except `getInviteLink`. Use a boolean for status actions and a string for participant or label actions.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "chat_id": {
      "type": "string",
      "description": "The id of the chat to be patched"
    },
    "action": {
      "type": "string",
      "description": "The action to perform on the chat:        - `setReadStatus`: (WhatsApp & LinkedIn only) Set the read status of the chat.        - `setMuteStatus`: (WhatsApp & LinkedIn only) Set the mute status of the chat.        - `setArchiveStatus`: (WhatsApp only) Set the archive status of the chat.        - `setPinnedStatus`: (WhatsApp only) Set the pinned status of the chat.        - `addParticipant`: (WhatsApp & Telegram only) Add a participant to the group chat.          The account owner must have the Add other members permission in the group.          Provide the provider ID as value, for example 334455667788@s.whatsapp.net for WhatsApp,          or a Telegram user ID, username, or phone number for Telegram.        - `removeParticipant`: (WhatsApp & Telegram only) Remove a participant from the group chat.          Provide the provider ID as value, for example 334455667788@s.whatsapp.net for WhatsApp,          or a Telegram user ID, username, or phone number for Telegram.        - `setLabel`: (WhatsApp only) Add a label to the chat.          If the label does not exist, it will be created and then assigned.        - `getInviteLink`: (WhatsApp & Telegram only) Generate or retrieve the full group invite link.          The account owner must have the required invite permissions in the group.",
      "enum": [
        "setReadStatus",
        "setMuteStatus",
        "setArchiveStatus",
        "setPinnedStatus",
        "addParticipant",
        "removeParticipant",
        "setLabel",
        "getInviteLink"
      ]
    },
    "value": {
      "description": "Required for every action except `getInviteLink`. Use a boolean for status actions and a string for participant or label actions."
    }
  },
  "required": [
    "PCID",
    "chat_id"
  ]
}

unipile_messaging_patch_message

Edit a message Parameters:

Parameter	Type	Required	Default	Description
`message_id`	string	Yes	—	The id of the message to edit.
`text`	string	No	—	The updated text of the message. For media messages, this is used as the updated caption when supported by the provider. On WhatsApp, edits may be rejected after an indicative 15-minute window following the original send time. On LinkedIn Classic, edits are only possible within the first 60 minutes after the message is sent.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "message_id": {
      "type": "string",
      "description": "The id of the message to edit."
    },
    "text": {
      "type": "string",
      "description": "The updated text of the message. For media messages, this is used as the updated caption when supported by the provider. On WhatsApp, edits may be rejected after an indicative 15-minute window following the original send time. On LinkedIn Classic, edits are only possible within the first 60 minutes after the message is sent."
    }
  },
  "required": [
    "PCID",
    "message_id"
  ]
}

unipile_messaging_send_message_in_chat

Send a message in a chat Parameters:

Parameter	Type	Required	Default	Description
`chat_id`	string	Yes	—	The id of the chat where to send the message.
`account_id`	string	No	—	An account_id can be specified to prevent the user from sending messages in chats not belonging to the account.
`attachments`	string[]	No	—	The attachments value
`quote_id`	string	No	—	The id of a message to quote. The id of the message to quote / reply to.
`text`	string	No	—	The text value
`thread_id`	string	No	—	Optional and for Slack’s messaging only. The id of the thread to send the message in.
`typing_duration`	string	No	—	(WhatsApp only) Set a duration in milliseconds to simulate a typing status for that duration before sending the message.
`video_message`	string	No	—	(Linkedin) A file to send as video message. WhatsApp: use attachments field.
`voice_message`	string	No	—	(Linkedin \| WhatsApp) A file to send as voice message. WhatsApp: prefer .mp3 or .m4a. Linkedin: prefer .m4a. Instagram: use the attachment field and prefer .m4a. Telegram: use the attachment field.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "chat_id": {
      "type": "string",
      "description": "The id of the chat where to send the message."
    },
    "account_id": {
      "type": "string",
      "description": "An account_id can be specified to prevent the user from sending messages in chats not belonging to the account."
    },
    "attachments": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "binary"
      },
      "description": "The attachments value"
    },
    "quote_id": {
      "type": "string",
      "description": "The id of a message to quote. The id of the message to quote / reply to."
    },
    "text": {
      "type": "string",
      "description": "The text value"
    },
    "thread_id": {
      "type": "string",
      "description": "Optional and for Slack's messaging only. The id of the thread to send the message in."
    },
    "typing_duration": {
      "type": "string",
      "description": "(WhatsApp only) Set a duration in milliseconds to simulate a typing status for that duration before sending the message."
    },
    "video_message": {
      "type": "string",
      "description": "(Linkedin) A file to send as video message. WhatsApp: use attachments field."
    },
    "voice_message": {
      "type": "string",
      "description": "(Linkedin | WhatsApp) A file to send as voice message. WhatsApp: prefer .mp3 or .m4a. Linkedin: prefer .m4a. Instagram: use the attachment field and prefer .m4a. Telegram: use the attachment field."
    }
  },
  "required": [
    "PCID",
    "chat_id"
  ]
}

unipile_messaging_start_new_chat

Start a new chat Parameters:

Parameter	Type	Required	Default	Description
`account_id`	string	Yes	—	An Unipile account id.
`attachments`	string[]	No	—	The attachments value
`attendees_ids`	string[]	Yes	—	One or more attendee provider ID. For `instagram`, please use the ‘provider_messaging_id’. For LinkedIn users, use a `provider_id` starting with: ACo for classic, ACw for Sales Navigator, AE for Recruiter. For LinkedIn company messaging, please use the ‘messaging_id’. For WhatsApp, please use ‘00000000@s.whatsapp.net’.
`linkedin`	object	No	—	Extra fields for Linkedin products
`subject`	string	No	—	An optional field to set the subject of the conversation.
`text`	string	No	—	The message that will start the new conversation. With LinkedIn recruiter, a range of HTML tags can be used directly in the body of the message to enhance the presentation. The supported tags are <strong> for bold text, <em> for italic text, <a href=“www.my-link.com”> for external links, <ul> for unordered lists, <ol> for ordered lists and <li> for list items. Tags can be nested into each other if necessary.
`video_message`	string	No	—	(Linkedin) A file to send as video message. WhatsApp: use attachments field.
`voice_message`	string	No	—	(Linkedin \| WhatsApp) A file to send as voice message. WhatsApp: prefer .mp3 or .m4a. Linkedin: prefer .m4a. Instagram: use the attachment field and prefer .m4a. Telegram: use the attachment field.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "account_id": {
      "type": "string",
      "description": "An Unipile account id."
    },
    "attachments": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "binary"
      },
      "description": "The attachments value"
    },
    "attendees_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "One or more attendee provider ID. For `instagram`, please use the 'provider_messaging_id'. For LinkedIn users, use a `provider_id` starting with: ACo for classic, ACw for Sales Navigator, AE for Recruiter. For LinkedIn company messaging, please use the 'messaging_id'. For WhatsApp, please use '00000000@s.whatsapp.net'."
    },
    "linkedin": {
      "description": "Extra fields for Linkedin products"
    },
    "subject": {
      "type": "string",
      "description": "An optional field to set the subject of the conversation."
    },
    "text": {
      "type": "string",
      "description": "The message that will start the new conversation. With LinkedIn recruiter, a range of HTML tags can be used directly in the body of the message to enhance the presentation. The supported tags are &lt;strong&gt; for bold text, &lt;em&gt; for italic text, &lt;a href=\"www.my-link.com\"&gt; for external links, &lt;ul&gt; for unordered lists, &lt;ol&gt; for ordered lists and &lt;li&gt; for list items. Tags can be nested into each other if necessary."
    },
    "video_message": {
      "type": "string",
      "description": "(Linkedin) A file to send as video message. WhatsApp: use attachments field."
    },
    "voice_message": {
      "type": "string",
      "description": "(Linkedin | WhatsApp) A file to send as voice message. WhatsApp: prefer .mp3 or .m4a. Linkedin: prefer .m4a. Instagram: use the attachment field and prefer .m4a. Telegram: use the attachment field."
    }
  },
  "required": [
    "PCID",
    "account_id",
    "attendees_ids"
  ]
}

unipile_messaging_sync_chat_history

Synchronize a conversation from its beginning Parameters:

Parameter	Type	Required	Default	Description
`chat_id`	string	Yes	—	The id of the chat to be synced.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "chat_id": {
      "type": "string",
      "description": "The id of the chat to be synced."
    }
  },
  "required": [
    "PCID",
    "chat_id"
  ]
}

Triggers API

Platform API

Embedded MCP Servers

Application MCP Servers

Skills Guides

Tools

unipile_messaging_add_reaction

unipile_messaging_delete_chat

unipile_messaging_delete_message

unipile_messaging_forward_message

unipile_messaging_get_attendee_by_id

unipile_messaging_get_attendee_profile_picture

unipile_messaging_get_chat

unipile_messaging_get_message

unipile_messaging_get_message_attachment

unipile_messaging_list_all_attendees

unipile_messaging_list_all_chats

unipile_messaging_list_all_messages

unipile_messaging_list_attendees

unipile_messaging_list_chat_messages

unipile_messaging_list_chats_by_attendee

unipile_messaging_list_messages_by_attendee

unipile_messaging_patch_chat

unipile_messaging_patch_message

unipile_messaging_send_message_in_chat

unipile_messaging_start_new_chat

unipile_messaging_sync_chat_history

Triggers API

Platform API

Embedded MCP Servers

Application MCP Servers

Skills Guides

Documentation Index

​Tools

​unipile_messaging_add_reaction

​unipile_messaging_delete_chat

​unipile_messaging_delete_message

​unipile_messaging_forward_message

​unipile_messaging_get_attendee_by_id

​unipile_messaging_get_attendee_profile_picture

​unipile_messaging_get_chat

​unipile_messaging_get_message

​unipile_messaging_get_message_attachment

​unipile_messaging_list_all_attendees

​unipile_messaging_list_all_chats

​unipile_messaging_list_all_messages

​unipile_messaging_list_attendees

​unipile_messaging_list_chat_messages

​unipile_messaging_list_chats_by_attendee

​unipile_messaging_list_messages_by_attendee

​unipile_messaging_patch_chat

​unipile_messaging_patch_message

​unipile_messaging_send_message_in_chat

​unipile_messaging_start_new_chat

​unipile_messaging_sync_chat_history

Tools

unipile_messaging_add_reaction

unipile_messaging_delete_chat

unipile_messaging_delete_message

unipile_messaging_forward_message

unipile_messaging_get_attendee_by_id

unipile_messaging_get_attendee_profile_picture

unipile_messaging_get_chat

unipile_messaging_get_message

unipile_messaging_get_message_attachment

unipile_messaging_list_all_attendees

unipile_messaging_list_all_chats

unipile_messaging_list_all_messages

unipile_messaging_list_attendees

unipile_messaging_list_chat_messages

unipile_messaging_list_chats_by_attendee

unipile_messaging_list_messages_by_attendee

unipile_messaging_patch_chat

unipile_messaging_patch_message

unipile_messaging_send_message_in_chat

unipile_messaging_start_new_chat

unipile_messaging_sync_chat_history