Create an Activity
POST {{base_url}}/activity
Use this endpoint to create a new activity in the Activities hub.
Specify the data for the new activity in the request body. To find out the required fields, data types, and other details to form a valid request JSON body, call the activity metadata. The Type and Subject fields are required for activity creation.
The table below includes field descriptions for the minimum required fields and default values to include in the request JSON to create an activity record. The metadata will have the most up to date details for your instance of Vantagepoint when calling the API using your authenticated environment.
Request
A successful call status of 201 Created returns the JSON representation for the newly created activity.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
requiredFieldValidation | string | Optional. |
The flag that indicates whether or not the validation for required screen designer fields is needed.
Use "N" if you want to bypass the validation. Otherwise, the default is "Y," which enforces the validation.
NOTE: This does not apply to required system fields. |
| startWorkflow | string | | Optional.
The flag that indicates whether or not the trigger for a workflow is initiated.
Use "N" if you want to bypass the trigger. Otherwise, the default is "Y," which initiates the workflow. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | Required. |
The type of content supported by the API endpoint. |
| Authorization | string | | Required.
The type of authorization supported by the API endpoint. |
| dvp-applicationId | string | | Optional.
The identifier for a specific area (or module) of your Vantagepoint instance.
This is mainly used for fetching records and also for enforcing security measures.
NOTE: This is required when working with Vantagepoint Connect and must be set to "Activity". |
RESPONSES
status: OK
[{"ActivityID":"FCEEB40E4C084C01B7338019D90FB17D","Type":"EMail","StartDate":"2018-04-08T14:00:00.270","EndDate":"2018-04-08T23:00:00.270","HasNotes":"N","Notes":"","CompletionInd":"N","Subject":"Example for API Traffic 2018 March 8","RecurrType":"","RecurrEndDate":"","CampaignID":"","MktName":"","OpportunityID":"","OppName":"","ProjName":"","WBS1":"","EndDateSort":"2018.04.08 EMail","Attendees":"Billy Boy Charles, Jr.","Associations":"","InstanceStartDate":"2018-04-08T14:00:00.270","StartDateObj":"2018-04-08T14:00:00.270","EndDateObj":"2018-04-08T23:00:00.270","RecurrStartDate":"","AllDayEventInd":"Y","RecurrenceInd":"N","RecurrDailyFreq":1,"RecurrDailyWeekDay":"N","RecurrWeeklyFreq":1,"RecurrWeeklySun":"N","RecurrWeeklyMon":"N","RecurrWeeklyTue":"N","RecurrWeeklyWed":"N","RecurrWeeklyThu":"N","RecurrWeeklyFri":"N","RecurrWeeklySat":"N","RecurrMonthlyFreq":1,"RecurrMonthlyOccur":0,"RecurrMonthlyDay":0,"RecurrMonthlyOccurInd":"N","RecurrMonthlyOccurDay":0,"RecurrMonthlyOccurFreq":1,"RecurrYearlyMonth":0,"RecurrYearlyDay":0,"RecurrEndType":"N","Employee":"00001","RP":"N","acType":"EMail","ShowTimeAs":"Busy","PrivateInd":"N","ReminderInd":"Y","ReminderUnit":15,"ReminderMinHrDay":"Minutes","ReminderDate":"2018-04-08T13:45:00.270","isTask":"Y","isCalendar":"N","MaxOccurences":0,"RecurrYearlyOccurInd":"N","RecurrYearlyOccurDay":0,"RecurrYearlyOccurMonth":0,"RecurrYearlyOccur":0,"Location":"","WBS2":"","WBS3":"","ClientName":"","ClientID":"","CreateEmployee":"00001","TypeName":"EMail","ContactID":"","LeadID":"","Priority":"High","OppEstStartDate":"","OppEstCompletionDate":"","custTestQuery":"","custTEst1":"","custUserdefinedfieldjb":"","PrimaryClient":"","PriorityDesc":"High","Duration":0,"Owner":"00001","OwnerName":"Billy Boy Charles, Jr.","ContactName":"","CreateUser":"Billy Boy Charles, Jr.","CreateDate":"2018-03-08T22:33:24.047","ModUser":"Billy Boy Charles, Jr.","ModDate":"2018-03-08T22:33:24.047","TaskCompletionDate":"","RecurrID":"","OutlookType":"Generic","Vendor":"","VendorName":"","ContactIDForVendor":"","ContactNameForVendor":"","ContactPhoneForVendor":"","EndDateFilter":"04/08/2018 EMail"}]