Loading ...

REST API: Send Connection Request | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Users » REST API: Connections » REST API: Send Connection Request
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 5

REST API: Send Connection Request

0 
 /5
0 (0votes)

Send Connection Request

POST /api/users/connections

Send a connection request to a user. Valid for Communifire version 6.0 and above.

Method Details

HTTP Method
POST
Response Format
JSON
Requires Authentication?
YES
Product Version
6.0 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)		 Communifire REST API key for the Communifire portal you are making the call for.
ConnectionUserID  &ConnectionUserID=x - Used in the request URL as a query parameter User ID of the user to whom you want to send the connection request.
RequestMessage Used in the request body Message to send to the connection recipient.

Example Request

POST https://myintranet.communifire.com/api/users/connections?ConnectionUserID=376

Body:

"Let's connect!"

Example Response

True/false is returned as ResponseData.

{
  "IsError": false,
  "ResponseMessage": "Connection request sent successfully.",
  "ResponseData": true
}

Please Note The content type that you pass in the header of your request should be application/json and RequestMessage should be in string format.

Wiki Index

Pages

Intranet Software