Send calendar invites programmatically through the A1Mail API with just a few lines of code
Parameter | Type | Required | Description |
---|---|---|---|
sender_address | string | Yes | Email address that will appear in the “From” field |
recipient_address | string | Yes | Email address of the recipient |
event_title | string | Yes | Title of the calendar event |
start_time | string | Yes | Start time of the event in ISO 8601 format (UTC) |
end_time | string | Yes | End time of the event in ISO 8601 format (UTC) |
organizer_name | string | Yes | Name of the event organizer |
method | string | Yes | Calendar method (REQUEST, CANCEL, REPLY) |
location | string | No | Location of the event |
description | string | No | Description of the event |
attendees | array | No | Array of attendee email addresses |
mail_headers | object | No | Additional email headers (sequence, etc.) |
sequence
number in mail_headers
to indicate this is an update to the original event.
YYYY-MM-DDTHH:MM:SSZ
2024-06-10T10:00:00Z
mail_headers
field, specifically the sequence
attribute, is used in calendar invites to manage updates to events. Here’s how it works:
0
0
to 1
)sequence: 0
sequence: 1
(e.g., time changed)sequence: 2
(e.g., location changed)sequence: 3