Create Connection

Sends a connection request to another user.

Sends an invitation to connect with another user

POSTyourpodURL.symphony.com/pod/v1/connection/create

Header parameters

Body

application/json

userIdinteger (int64)

user id

Example: 769658112378

Response

200400401403404500

OK

Body

application/json

userIdinteger (int64)

user id

Example: 769658112378

statusenum

Connection status between the requesting user and the request sender

Example: "ACCEPTED"

PENDING_INCOMINGPENDING_OUTGOINGACCEPTEDREJECTED

firstRequestedAtinteger (int64)

unix timestamp when the first request was made

Example: 1470018073812

updatedAtinteger (int64)

unix timestamp on the last updated date

Example: 1471018076255

requestCounterinteger (int32)

number of requests made

Example: 1

Request

JavaScriptCurlPython

const response = await fetch('yourpodURL.symphony.com/pod/v1/connection/create', {
    method: 'POST',
    headers: {
      "sessionToken": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401403404500

{
  "userId": 769658112378,
  "status": "ACCEPTED",
  "firstRequestedAt": 1470018073812,
  "updatedAt": 1471018076255,
  "requestCounter": 1
}

📘 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