Start a new chat

post

https://{subdomain}.unipile.com:{port}/api/v1/chats

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

account_id

string

required

length ≥ 1

An Unipile account id.

text

string

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.

attachments

array of files

attachments

voice_message

file

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

file

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

attendees_ids

array of strings

required

length ≥ 1

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 '[email protected]'.

attendees_ids*

subject

string

An optional field to set the subject of the conversation.

Extra fields for Linkedin products

Responses

400

      ## Bad Request
      ### Too many characters
      The provided content exceeds the character limit.

undefined

401

      ## Unauthorized
      ### Disconnected account
      The account appears to be disconnected from the provider service.

undefined

403

      ## Forbidden
      ### Feature not subscribed
      The requested feature has either not been subscribed or not been authenticated properly.

undefined

404

    ## Not Found
    ### Resource not found.
    The requested resource were not found.

undefined

415

      ## Unsupported Media Type
      ### Unsupported media
      The media has been rejected by the provider.

undefined

422

      ## Unprocessable Entity
      ### Recipient cannot be reached
      The recipient appears not to be first degree connection.

undefined

429

    ## Too Many Requests
    ### Too many requests
    The provider cannot accept any more requests at the moment. Please try again later.

undefined

501

    ## Not Implemented
    ### Missing feature
    Requested feature is planned but has not been implemented yet.

undefined

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Start a new chat

Internal Server Error

Unexpected error - Type: "errors/unexpected_error"

Provider error - Type: "errors/provider_error"

Authentication intent error - Type: "errors/authentication_intent_error"

Service Unavailable

No client session - Type: "errors/no_client_session"

No channel - Type: "errors/no_channel"

Handler missing - Type: "errors/no_handler"

Network down - Type: "errors/network_down"

Service unavailable - Type: "errors/service_unavailable"

Gateway Timeout

Request timed out - Type: "errors/request_timeout"

201Created. New chat created and message sent successfully.

400 ## Bad Request ### Too many characters The provided content exceeds the character limit. undefined

401 ## Unauthorized ### Disconnected account The account appears to be disconnected from the provider service. undefined

403 ## Forbidden ### Feature not subscribed The requested feature has either not been subscribed or not been authenticated properly. undefined

404 ## Not Found ### Resource not found. The requested resource were not found. undefined

415 ## Unsupported Media Type ### Unsupported media The media has been rejected by the provider. undefined

422 ## Unprocessable Entity ### Recipient cannot be reached The recipient appears not to be first degree connection. undefined

429 ## Too Many Requests ### Too many requests The provider cannot accept any more requests at the moment. Please try again later. undefined

Internal Server Error

Unexpected error - Type: "errors/unexpected_error"

Provider error - Type: "errors/provider_error"

Authentication intent error - Type: "errors/authentication_intent_error"

501 ## Not Implemented ### Missing feature Requested feature is planned but has not been implemented yet. undefined

Service Unavailable

No client session - Type: "errors/no_client_session"

No channel - Type: "errors/no_channel"

Handler missing - Type: "errors/no_handler"

Network down - Type: "errors/network_down"

Service unavailable - Type: "errors/service_unavailable"

504Gateway Timeout Request timed out - Type: "errors/request_timeout" Request Timeout. Please try again, and if the issue persists, contact support.

Gateway Timeout

Request timed out - Type: "errors/request_timeout"