Skip to main content
Get Appointment Email Invitation

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$select
string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Body

Appointment, TemplateName, Language

GetAppointmentEmailInvitation: Create an EMailEntity (without an ical attachment) with the email sent to participants when the appointment is saved

Appointment
object

Partial AppointmentEntity class associating the generated AppointmentEntity with an interface.

TemplateName
string
Language
string

Response

OK

All information about an e-mail Carrier object for EMailEntity. Services for the EMailEntity Carrier is available from the EMail Agent.

To
object[]

To recipients of e-mail

Cc
object[]

Cc recipients of e-mail

Bcc
object[]

Bcc recipient of e-mail

Subject
string

Subject of the e-mail

HTMLBody
string

Body formatted in HTML

From
object

Carrier object for EMailAddress. Services for the EMailAddress Carrier is available from the EMail Agent.

Sent
string<date-time>

When was the e-mail sent

Size
integer<int32>

Total size of the e-mail

Priority
enum<string>

Importance of the e-mail

Available options:
NoPriority,
Highest,
High,
Normal,
Low,
Lowest
Flags
enum<string>

Flag status of this mail (unread, replied, deleted )

Available options:
None,
Seen,
Deleted,
Recent,
Flagged,
Draft,
Answered
MessageID
string

Unique id of e-mails

PlainBody
string

Body formatted in plain text

IsSent
boolean

Is this a sent e-mail (not new)

EMailSOInfo
object

Glue between SuperOffice data and an e-mail. Carrier object for EMailSOInfo. Services for the EMailSOInfo Carrier is available from the EMail Agent.

ServerId
integer<int32>

Unique id for the e-mail on the server

ServerIdentifier
string

Server identifier of this email item (GraphApi uses string Id's)

Attachments
object[]
CustomHeaderList
object[]

Non standard e-mail headers

FolderName
string

Name of folder the e-mail belongs in

EmailItemId
integer<int32>

Primary key

AccountId
integer<int32>

Account Id

ReceivedAt
string<date-time>

Received date time

InReplyTo
object

Limited information about one e-mail. Carrier object for EMailEnvelope. Services for the EMailEnvelope Carrier is available from the EMail Agent.

RepliedAt
string<date-time>

When this email was replied at

HasCalendarData
boolean

If this email contains exactly one iCal appointment

CalMethod
enum<string>

Method stored in the associated iCal appointment. Indicates if the iCal data is a reply, counter proposal etc.

Available options:
Unknown,
Add,
Cancel,
Counter,
DeclineCounter,
Publish,
Refresh,
Reply,
Request
CalReplyStatus
enum<string>

Reply status stored in calendar data for the ical method is REPLY

Available options:
Unknown,
Accepted,
Declined,
Tentative
TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.