POST v1/user/{userId}/communications

Post/Start a new communication

Request Information

URI Parameters

Name	Description	Type	Additional information
userId	User id	decimal number	Required

Body Parameters

Communication detail object

AppCommunicationStartRequest

Name	Description	Type	Additional information
Attachments	Communication attachments	Collection of AppAttachmentRequest	None.
Receivers		Collection of integer	None.
ReceiversStr		string	None.
Subject		string	None.
Message		string	None.

Request Formats

application/json, text/json

Sample:

{
  "Attachments": [
    {
      "FileName": "sample string 1",
      "ContentType": "sample string 2",
      "FileContents": "sample string 3",
      "ImageType": "sample string 4"
    },
    {
      "FileName": "sample string 1",
      "ContentType": "sample string 2",
      "FileContents": "sample string 3",
      "ImageType": "sample string 4"
    }
  ],
  "Receivers": [
    0
  ],
  "ReceiversStr": "0",
  "Subject": "sample string 2",
  "Message": "sample string 3"
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AppCommunicationStartRequest'.

Response Information

Resource Description

ApiResponseOfCommunicationMaster

Name	Description	Type	Additional information
Result		CommunicationMaster	None.
Status		boolean	None.
Message		string	None.
Errors	Errors occures while processing request	Collection of ApiError	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": {
    "Subject": "sample string 1",
    "RecentUserId": 2,
    "RecentUserName": "sample string 3",
    "RecentMessage": "sample string 4",
    "Threads": [
      {
        "Id": 1,
        "UserId": 3,
        "UserName": "sample string 4",
        "Message": "sample string 5",
        "DateOfCreation": "2025-04-22T15:49:40.7513364+01:00",
        "Attachments": [
          {
            "Id": 1,
            "FileName": "sample string 4",
            "ContentType": "sample string 6"
          },
          {
            "Id": 1,
            "FileName": "sample string 4",
            "ContentType": "sample string 6"
          }
        ]
      },
      {
        "Id": 1,
        "UserId": 3,
        "UserName": "sample string 4",
        "Message": "sample string 5",
        "DateOfCreation": "2025-04-22T15:49:40.7513364+01:00",
        "Attachments": [
          {
            "Id": 1,
            "FileName": "sample string 4",
            "ContentType": "sample string 6"
          },
          {
            "Id": 1,
            "FileName": "sample string 4",
            "ContentType": "sample string 6"
          }
        ]
      }
    ],
    "Users": [
      {
        "UserId": 2,
        "UserName": "sample string 3",
        "Status": 0,
        "LastUpdatedOn": "2025-04-22T15:49:40.7513364+01:00"
      },
      {
        "UserId": 2,
        "UserName": "sample string 3",
        "Status": 0,
        "LastUpdatedOn": "2025-04-22T15:49:40.7513364+01:00"
      }
    ],
    "IsNewRecord": false,
    "UserId": 7,
    "Id": 8,
    "F_CompanyMaster": 9,
    "Name": "sample string 10"
  },
  "Status": true,
  "Message": "sample string 2",
  "Errors": [
    {
      "Number": 1,
      "Message": "sample string 2",
      "Exception": {
        "ClassName": "System.Exception",
        "Message": null,
        "Data": null,
        "InnerException": null,
        "HelpURL": "sample string 1",
        "StackTraceString": null,
        "RemoteStackTraceString": null,
        "RemoteStackIndex": 0,
        "ExceptionMethod": null,
        "HResult": 3,
        "Source": "sample string 2",
        "WatsonBuckets": null
      }
    },
    {
      "Number": 1,
      "Message": "sample string 2",
      "Exception": {
        "ClassName": "System.Exception",
        "Message": null,
        "Data": null,
        "InnerException": null,
        "HelpURL": "sample string 1",
        "StackTraceString": null,
        "RemoteStackTraceString": null,
        "RemoteStackIndex": 0,
        "ExceptionMethod": null,
        "HResult": 3,
        "Source": "sample string 2",
        "WatsonBuckets": null
      }
    }
  ]
}