Add Calendar Events

Create a calendar event on a record.

POSThttps://secure-api.setshape.com/api/lead/add/calendar/event/{crmid}

Replace {crmid} with your Shape system ID — found on the API Integrations page. Every request also needs your auth header — see Using Shape APIs.

Body parameters

Field	Requirement	Description
`lead_id`	Required	Shape record ID.
`title`	Required	Event title.
`eventType`	Required	Event-type title. If omitted, an uncategorized event is created and event-type triggers do not run.
`date`	Required unless <code class="apidoc-ic">dateTime</code> is used	Date in `MM-DD-YYYY` format.
`dateTime`	Alternative to <code class="apidoc-ic">date</code>	Parseable combined date and time.
`time`	Optional	Start time, e.g. `03:30 PM`; a date without a time resolves to midnight.
`endTime`	Optional	Event end time on the same date.
`timezone`	Optional	IANA timezone such as `America/New_York`; defaults to the Shape company’s timezone.
`location`	Optional	Event location.
`description`	Optional	Event description/notes.
`assignTo`	Optional	Comma-separated Shape user email addresses.
`recurringSchedule`	Optional	Recurrence value consumed by Shape.

Example request

{
  "lead_id": 123,
  "title": "Sample Calendar Event",
  "eventType": "Appointment",
  "date": "01-31-2030",
  "time": "03:30 PM",
  "endTime": "04:00 PM",
  "timezone": "America/Los_Angeles",
  "location": "1234 Main Street, Irvine, CA 92618"
}

Example response

{
  "message": "Calendar event added for Joe successfully",
  "recordID": 123
}