Create Connection

Sends a connection request to another user.
post
https://yourpodURL.symphony.com/pod
/v1/connection/create
Sends an invitation to connect with another user
Parameters
Header
sessionToken*
string
Session authentication token.
Body
userId
integer
user id
Body
Example
Schema
{
"userId": 769658112378
}
Responses
200: OK
OK
400: Bad Request
Client error, see response body for further details.
401: Unauthorized
Unauthorized: Invalid session token.
403: Forbidden
Forbidden: Caller lacks necessary entitlement.
404: Not Found
Not Found: User cannot be found.
500: Internal Server Error
Server error, see response body for further details.

📘 Internal Connections

Users who belong to the same private pod are implicitly connected. If you attempt to connect with an internal user, this endpoint will return the corresponding connection object with a status of accepted.

📘 Note

  • When calling this as an OBO-enabled endpoint, use the OBO User Authenticate token for sessionToken.
  • Pods from all users involved need to have crossPod enabled between them.
  • Only one connection request is allowed between two users. When this limit is exceeded, no more connections requests are allowed. A new connection request will be allowed only if the user that received the connection request declines it.

Connection Behaviour

Currently, there are four possible connection status:
  • PENDING_INCOMING: The specified user requested to connect with the calling user.
  • PENDING_OUTGOING: The calling user requested to connect with the specified user.
  • ACCEPTED: The two users are connected.
  • REJECTED: The two users are not connected.
The following table shows the connection current behaviors:
Initial Connection Status
Request Action
New Connection Status
None (connection did not exist)
Connect
PENDING_OUTGOING
PENDING_INCOMING
Accept
ACCEPTED
PENDING_INCOMING
Reject
REJECTED
Last modified 2mo ago