POST api/activities

Insert an Activity.

Request Information

URI Parameters

None.

Body Parameters

ActivityDto
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
ContactStatusId

A reference to the primary key of the ContactStatus record that is associated with this record. For POST requests sent to the API if this value is not provided it will be set to the Default ContactStatus record.

 integer

Range: inclusive between 1 and 99999999
ContactStatusName

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

 string

None.
IntakeId

A reference to the primary key of the Intake record that is associated with this record. For POST requests sent to the API if this value is not provided it will be set to the Default Intake record.

 integer

Range: inclusive between 1 and 99999999
IntakeName

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

 string

None.
DateCreated

The date that the Activity 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. For GET requests always returned as NULL.

 InnerTaskDto

None.

Request Formats

application/json, text/json

Sample: 
{
  "Id": 1,
  "CrmNumber": 2,
  "ContactStatusId": 1,
  "ContactStatusName": "sample string 3",
  "IntakeId": 1,
  "IntakeName": "sample string 4",
  "DateCreated": "2024-05-20T09:50:30.4344705+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