Create IM non-inclusive

Creates a new instant message conversation or returns an existing IM between the specified users, but excluding the calling user.

Important: This endpoint also allows the creation of Multi-party Instant Messages (MIM), which are not supported anymore. If you need to create a chat with several participants, please create a room instead.

Create a new single or multi party instant message conversation

post

At least two user IDs must be provided or an error response will be sent.

The caller is not included in the members of the created chat.

Duplicate users will be included in the membership of the chat but the duplication will be silently ignored.

If there is an existing IM conversation with the same set of participants then the id of that existing stream will be returned.

Header parameters

sessionTokenstringRequired

Session authentication token.

Bodyinteger · int64[]

application/json

integer · int64[]OptionalExample: [7215545058313,7215545078461]

Responses

200

OK

application/json

400

Client error, see response body for further details.

application/json

401

Unauthorized: Invalid session token.

application/json

403

Forbidden: Caller lacks necessary entitlement.

application/json

500

Server error, see response body for further details.

application/json

post

/v1/admin/im/create

HTTPcURLJavaScriptPython

POST /pod/v1/admin/im/create HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Content-Type: application/json
Accept: */*
Content-Length: 29

[
  7215545058313,
  7215545078461
]

{
  "id": "xhGxbTcvTDK6EIMMrwdOrX___quztr2HdA"
}

• Two participants must be specified.

• If a user ID appears in the list multiple times, duplicates will be ignored.

• If there is an existing IM conversation with the specified participants, then the id of the existing stream will be returned.

• Use Create IM to include the calling user.

🚧 Required Permissions

This endpoint can only be called by Service Users with the User Provisioning role. See Bot Permissions for a list of roles and associated privileges.

📘 Overview of streams

A stream is like a container for messages exchanged between two or more users via a given instant message (IM) or chat room. For more information, refer to Overview of streams.