UNunipile
Messaging

Start a new chat

Changed on

Start a new conversation with one or more attendee. ⚠️ Interactive documentation does not work for Linkedin specific parameters (child parameters not correctly applied in snippet), the correct format is linkedin[inmail] = true, linkedin[api]...

post/api/v1/chats

Request

Request body multipart/form-data

account_idstring required

An Unipile account id.

textstring

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.

attachmentsstring[]
voice_messagestring binary

(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.

video_messagestring binary

(Linkedin) A file to send as video message. WhatsApp: use attachments field.

attendees_idsstring[] required

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'.

subjectstring

An optional field to set the subject of the conversation.

Response

Created. New chat created and message sent successfully.

object'ChatStarted' required

Changes

  • e74f29ca2aaaRevision changes
    • warning

      added the new errors/connection_limit_reached enum value to the response property for the response status

    • warning

      added the new errors/not_supported_by_provider enum value to the response property for the response status

    • warning

      added the new errors/password_reset_required enum value to the response property for the response status

    • warning

      added the new errors/target_audience_too_small enum value to the response property for the response status

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the optional property to the response with the status