API Add Calendar Events - Shape Software - Automate your business!

Instructions

Shape Software API

  • Introduction
  • Using Shape APIs
  • Status Codes
  • Rate Limits

POST API Calls

GET API Calls

Add Calendar Events

POST /lead/add/calendar/event

To create calendar events, send an authorized POST request to https://secure.setshape.com/api/lead/add/calendar/event

Parameters

Create calendar events with these parameters:

Parameter — Lead ID is the record identifier on which to create the event.

Parameter — Create the name of the calendar event.

Parameter — Add an address into the location field to arm users with the location an event takes place at.

Parameter — Categorize the event into a specific event type classification found in “Manage Event Types” in settings.

Parameter — Notate the start date of the event to save on the calendar. To set the date, the format should be in MM-DD-YYYY format.

Parameter — Appoint the start time of the calendar event. The time format should be in HH:MM AP format. (AP = AM/PM)

Parameter — Establish an end time for the event. The time format should be in HH:MM AP format. (AP = AM/PM)

Request Header

The authentication token should be passed in the request header for every API request. 

Content-Type: application/json
Authorization=xxxxxxxxxxxxxxxxxxxxxxxx

Request Body

JSON request body formatting example:

{
  "lead_id": "12345",
  "title": "Sample Calendar Event",
  "location": "1234 Main Street",
  "date": "01-31-2030",
  "time": "03:30 PM",
}

Response

Upon success, the server returns HTTP codes and messages in the header with some additional elements and properties that are set by the server, such as id.

{
  "message": "Calendar event added successfully.",
  "recordId": 12345
}

How to Get Field Names

Field names can be found within your CRM System’s settings pages under: Settings > Marketing Sources > Edit Any Marketing Source > Campaign Source Post URL Instructions.

 

After navigating to the marketing sources settings page and opening up a campaign, scroll to the bottom of the page to the “Campaign Source Post URL Instructions” section. Here, you will find a searchable table with a breakdown of all of the field names available for use. These field names can also be exported to a CSV via the “Export” dropdown.