POST api/othercommunications

Insert an OtherCommunication.

Request Information

URI Parameters

None.

Body Parameters

OtherCommunicationDto
NameDescriptionTypeAdditional information
Id

The primary key of the record in the Hobsons database. Ignored for POST requests sent to the API.

 integer

None.
CrmNumber

A reference to the primary key of the Contact record that is associated with this record.

 integer

Required

Range: inclusive between 1 and 2147483647
Headline

The communication headline.

 string

String length: inclusive between 0 and 400
Incoming

Indicates if communication is incoming (true) or outgoing (false).

 boolean

Required
CommunicationTypeId

A reference to the primary key of the CommunicationType record that is associated with this record.

 integer

Required

Range: inclusive between 1 and 99999999
CommunicationTypeName

The name of the CommunicationType record that is associated with this record. Ignored for POST requests sent to the API.

 string

None.
CommunicationCategoryId

A reference to the primary key of the CommunicationCategory record that is associated with this record. The CommunicationCategory record cannot be 'Email' or 'Phone'.

 integer

Required

Range: inclusive between 1 and 99999999
CommunicationCategoryName

The name of the CommunicationCategory record that is associated with this record. Ignored for POST requests sent to the API.

 string

None.
SubChannelId

A reference to the primary key of the SubChannel record that is associated with this record. For POST requests sent to the API, the SubChannel record must belong to the parent Channel named 'External'.

 integer

Required

Range: inclusive between 1 and 99999999
SubChannelName

The name of the SubChannel record that is associated with this record. Ignored for POST requests sent to the API.

 string

None.
ChannelId

A reference to the primary key of the Channel record that is the parent of the SubChannel record. Ignored for POST requests sent to the API.

 integer

None.
ChannelName

The name of the Channel record that is the parent of the SubChannel record. Ignored for POST requests sent to the API.

 string

None.
SendExternal

Indicates if communication is sent externally (true) or internally (false).

 boolean

None.
Source

The source of the communication.

 string

String length: inclusive between 0 and 1000
ReferralSource

The referral source of the communication.

 string

String length: inclusive between 0 and 1000
DateCreated

The date that the communication record was created (in the Hobsons database). Ignored for POST requests sent to the API.

 date

None.
Task

The details of the Task record created that it's associated with this record. Used ONLY for POST requests sent to the API. Always returned as NULL.

 InnerTaskDto

None.

Request Formats

application/json, text/json

Sample: 
{
  "Id": 1,
  "CrmNumber": 1,
  "Headline": "sample string 2",
  "Incoming": true,
  "CommunicationTypeId": 1,
  "CommunicationTypeName": "sample string 4",
  "CommunicationCategoryId": 5,
  "CommunicationCategoryName": "sample string 6",
  "SubChannelId": 1,
  "SubChannelName": "sample string 7",
  "ChannelId": 1,
  "ChannelName": "sample string 8",
  "SendExternal": true,
  "Source": "sample string 9",
  "ReferralSource": "sample string 10",
  "DateCreated": "2024-05-20T09:12:27.2638809+10:00",
  "Task": {
    "TaskTypeId": 1,
    "Description": "sample string 2"
  }
}

Response Information

Resource Description

The primary key (id) of the record inserted in the Hobsons database.

integer

Response Formats

application/json, text/json

Sample: 
1