younifyd
Menu

Post /scheduler/v3/meetings/calendar

Create a new calendar meeting event.

POST/scheduler/v3/meetings/calendar

Use it in a workflow

  1. Add a step and choose the HubSpot connector.
  2. Pick the Post /scheduler/v3/meetings/calendar action (under Meetings).
  3. Fill in the fields below, then reference the result from later steps as {{postSchedulerV3MeetingsCalendar.response.data}}.

Request

Query parameters

organizerUserIdstringrequired

Request body

Enter the body as JSON in the step's Body field.

associationsarray<object>required
toobjectrequired1 fields

Contains the Id of a Public Object

typesarray<object>required2 fields
emailReminderScheduleobjectrequired
remindersarray<object>required2 fields
shouldIncludeInviteDescriptionbooleanrequired

Whether the invite description should be included in the reminder.

propertiesobjectrequired
hs_activity_typestring

The activity type of the meeting. Acceptable values are based on portal defined call and meeting types.

hs_attachment_idsarray<string>
hs_attendee_owner_idsarray<string>
hs_internal_meeting_notesstring

Internal notes related to the meeting.

hs_meeting_bodystring

The description of the meeting and calendar event.

hs_meeting_end_timestring (date-time)required

The time that the meeting should end in ISO 8601 format.

hs_meeting_locationstring

The physical address, virtual location, or phone number where the meeting will take place.

hs_meeting_location_typestring

The type of location for the meeting. Acceptable values are: ADDRESS, CUSTOM, PHONE.

One ofADDRESSCUSTOMPHONE

hs_meeting_outcomestringrequired

The outcome of the meeting. Acceptable default values are: SCHEDULED, COMPLETED, RESCHEDULED, NO_SHOW, CANCELED. This property can be changed to include additional custom values.

hs_meeting_start_timestring (date-time)required

The time that the meeting should start in ISO 8601 format.

hs_meeting_titlestringrequired

The title of the meeting and calendar event.

hs_timestampstring (date-time)required

The time that the meeting should start in ISO 8601 format. This value should be the same as `hs_meeting_start_time`.

hubspot_owner_idstringrequired

The ownerId of the HubSpot user who will host the meeting.

timezonestringrequired

The timezone property that will be set on the meeting event.

json
{
  "associations": [
    {
      "to": {
        "id": "string"
      },
      "types": [
        {
          "associationCategory": "HUBSPOT_DEFINED",
          "associationTypeId": 0
        }
      ]
    }
  ],
  "emailReminderSchedule": {
    "reminders": [
      {
        "numberOfTimeUnits": 0,
        "timeUnit": "DAYS"
      }
    ],
    "shouldIncludeInviteDescription": false
  },
  "properties": {
    "hs_meeting_end_time": "2025-01-01T00:00:00Z",
    "hs_meeting_outcome": "string",
    "hs_meeting_start_time": "2025-01-01T00:00:00Z",
    "hs_meeting_title": "string",
    "hs_timestamp": "2025-01-01T00:00:00Z",
    "hubspot_owner_id": "string",
    "hs_activity_type": "string",
    "hs_attachment_ids": [
      "string"
    ],
    "hs_attendee_owner_ids": [
      "string"
    ],
    "hs_internal_meeting_notes": "string",
    "hs_meeting_body": "string",
    "hs_meeting_location": "string"
  },
  "timezone": "string"
}

Response

Returns 200 with an object. Read it in later steps with {{postSchedulerV3MeetingsCalendar.response.data.<field>}}.

createdAtstring (date-time)

The date and time when the meeting event was initially created, in ISO 8601 format.

idstring

The unique identifier for the meeting event.

lastUpdatedAtstring (date-time)

The date and time when the meeting event was last updated, in ISO 8601 format.

propertiesobject
hs_activity_typestring

The activity type of the meeting. Acceptable values are based on portal defined call and meeting types.

hs_attachment_idsarray<string>
hs_attendee_owner_idsarray<string>
hs_engagement_sourcestringrequired

The source of the engagement, will always be `MEETINGS`.

One ofACADEMYACCEPTANCE_TESTACTIVITY_AUTO_ASSOCIATEACTIVITY_LOG_REVERTADSAI_GROUPANALYTICSAPIAPPROVALSASSISTSASSOCIATIONSAUTO_ASSOCIATE_BY_DOMAINAUTOMATION_JOURNEYAUTOMATION_PLATFORMAVATARS_SERVICEBATCH_UPDATEBCC_TO_CRMBEHAVIORAL_EVENTSBET_ASSIGNMENTBET_CRM_CONNECTORBIDENBILLINGBOTBREEZE_AGENTCALCULATEDCENTRAL_EXCHANGE_RATESCHATSPOTCLONE_OBJECTSCOMMUNICATORCOMPANIESCOMPANY_FAMILIESCOMPANY_INSIGHTSCONNECTED_ACCOUNTCONTACTSCONTACTS_WEBCONTENT_MEMBERSHIPCONVERSATIONAL_ENRICHMENTCONVERSATIONSCRM_PROCESSES_PLATFORMCRM_UI

hs_engagement_source_idstringrequired

The ID associated with the process created the engagement. Should always be empty when creating meeting events through this API.

hs_include_description_in_reminderstring

Whether to include the meeting description in the reminder.

hs_internal_meeting_notesstring

Internal notes related to the meeting.

hs_meeting_bodystring

The description of the meeting and calendar event.

hs_meeting_end_timestring (date-time)required

The end time of the meeting in ISO 8601 format.

hs_meeting_external_urlstring

The calendar event URL for the meeting.

hs_meeting_locationstring

The physical address, virtual location, or phone number where the meeting will take place.

hs_meeting_location_typestring

The type of location for the meeting. Acceptable values are: ADDRESS, CUSTOM, PHONE.

One ofADDRESSCUSTOMPHONE

hs_meeting_outcomestringrequired

The outcome of the meeting. Acceptable default values are: SCHEDULED, COMPLETED, RESCHEDULED, NO_SHOW, CANCELED. This property can be changed to include additional custom values.

hs_meeting_start_timestring (date-time)required

The start time of the meeting in ISO 8601 format.

hs_meeting_titlestringrequired

The title of the meeting and calendar event.

hs_timestampstring (date-time)required

The time that the meeting should start in ISO 8601 format. This value should be the same as `hs_meeting_start_time`.

hs_unique_idstring

The unique ID of the created calendar event.

hubspot_owner_idstring

The owner ID of the HubSpot user hosting the meeting.

json
{
  "createdAt": "2025-01-01T00:00:00Z",
  "id": "string",
  "lastUpdatedAt": "2025-01-01T00:00:00Z",
  "properties": {
    "hs_engagement_source": "ACADEMY",
    "hs_engagement_source_id": "string",
    "hs_meeting_end_time": "2025-01-01T00:00:00Z",
    "hs_meeting_outcome": "string",
    "hs_meeting_start_time": "2025-01-01T00:00:00Z",
    "hs_meeting_title": "string",
    "hs_timestamp": "2025-01-01T00:00:00Z",
    "hs_activity_type": "string",
    "hs_attachment_ids": [
      "string"
    ],
    "hs_attendee_owner_ids": [
      "string"
    ],
    "hs_include_description_in_reminder": "string",
    "hs_internal_meeting_notes": "string"
  }
}

Need more? See the HubSpot guide for connection setup and behaviour shared by every action.