POST api/Activities

Create a new Activity

Request Information

URI Parameters

None.

Body Parameters

Activity
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

SeriesId

globally unique identifier

None.

AccessorID

globally unique identifier

None.

IsCleared

boolean

None.

IsAlarmCreated

boolean

None.

IsAlarmed

boolean

None.

LeadMinutes

integer

None.

AlarmDue

string

None.

ExternalID

string

None.

Location

string

None.

IsTimeless

boolean

None.

IsPrivate

boolean

None.

PriorityId

integer

None.

ActivityPriorityName

string

None.

ActivityTypeId

integer

None.

ActivityTypeName

string

None.

Subject

string

None.

ScheduledBy

string

None.

ScheduledFor

string

None.

ScheduledForID

globally unique identifier

None.

ScheduledByID

globally unique identifier

None.

DeletedDates

Collection of date

None.

ClearedDates

Collection of date

None.

RecurSpec

ActivityRecurSpec

None.

EditDate

date

None.

CreateDate

date

None.

OccurTime

date

None.

OccurEndTime

date

None.

StartTime

SQL Column Name: [START_DATE_TIME]

date

None.

EndTime

SQL Column Name: [END_DATE_TIME]

date

None.

Details

SQL Column Name: [DETAILS]

string

None.

LinkedEntities

LinkedEntities

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": "3b9d189b-a185-4f4e-a410-12e1a1e6873e",
  "SeriesId": "089c26fd-a871-4e54-995d-4047a00f9c6c",
  "AccessorID": "729c574a-8722-46b4-b723-c786235ab7b4",
  "IsCleared": true,
  "IsAlarmCreated": true,
  "IsAlarmed": true,
  "LeadMinutes": 7,
  "AlarmDue": "sample string 8",
  "ExternalID": "sample string 9",
  "Location": "sample string 10",
  "IsTimeless": true,
  "IsPrivate": true,
  "PriorityId": 13,
  "ActivityPriorityName": "sample string 14",
  "ActivityTypeId": 15,
  "ActivityTypeName": "sample string 16",
  "Subject": "sample string 17",
  "ScheduledBy": "sample string 18",
  "ScheduledFor": "sample string 19",
  "ScheduledForID": "79872432-1bab-4d96-ae94-de0eccda832e",
  "ScheduledByID": "e9e518ac-436d-4f04-a71c-a7071014b981",
  "DeletedDates": [
    "2024-12-05T02:24:00Z",
    "2024-12-05T02:24:00Z"
  ],
  "ClearedDates": [
    "2024-12-05T02:24:00Z",
    "2024-12-05T02:24:00Z"
  ],
  "RecurSpec": {
    "Month": 1,
    "Frequency": 2,
    "Day": {
      "DayAsInt": 1
    },
    "OptOutValue": true,
    "Operator": "sample string 4",
    "AuthManager": "sample string 5",
    "Field": "sample string 6",
    "EndDate": "2024-12-05T02:24:00Z",
    "eValue": 8,
    "CallListName": "sample string 9",
    "IsEndless": true
  },
  "EditDate": "2024-12-05T02:24:00Z",
  "CreateDate": "2024-12-05T02:24:00Z",
  "OccurTime": "2024-12-05T02:24:00Z",
  "OccurEndTime": "2024-12-05T02:24:00Z",
  "StartTime": "2024-12-05T02:24:00Z",
  "EndTime": "2024-12-05T02:24:00Z",
  "Details": "sample string 28",
  "LinkedEntities": {
    "Contacts": [
      "96e9a696-a748-4282-8cee-f0fc2f9dd148",
      "4ee46a92-7b05-4a9d-bd8e-76ca99b28ba5"
    ],
    "Companies": [
      "294ce803-5c98-4226-bd50-521b35a9ab19",
      "1bc7316e-0b2d-430c-b34c-4f74a77dbf14"
    ],
    "Groups": [
      "0836ccab-daff-4041-b201-e8430d96cbc7",
      "1388f3c5-3432-497d-a3dc-25973b4ee701"
    ],
    "Opportunities": [
      "4920b80c-219b-4afb-8d42-0c2d63975073",
      "9738f5d4-de8b-4207-bf17-44474cbeed1e"
    ]
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

globally unique identifier

Response Formats

application/json, text/json

Sample:
"a3ba9a95-4dea-4dde-9d54-ffbcc7c32669"