Skip to main content
Create Appointment For U I D

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

AppointmentEntity, UID

CreateAppointmentForUID: Create an invitation record and an appointment with a given UID to reserve it if the UID is unused, otherwise null.

AppointmentEntity
object

Partial AppointmentEntity class associating the generated AppointmentEntity with an interface.

UID
string

Response

OK

Partial AppointmentEntity class associating the generated AppointmentEntity with an interface.

Associate
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

Contact
object

Carrier object for Contact. Services for the Contact Carrier is available from the Contact Agent.

CreatedBy
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

UpdatedBy
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

CreatedDate
string<date-time>

Registered date in UTC.

AppointmentId
integer<int32>

Primary key

Description
string

Description of the appointment.

Title
string

The title of the appointment.

Agenda
string

The agenda of the appointment.

InternalNotes
string

Internal notes for the appointment.

StartDate
string<date-time>

date + start time planned

EndDate
string<date-time>

Date + end time planned

InvitedPerson
object

Carrier object for Person. Services for the Person Carrier is available from the Person Agent.

Person
object

Carrier object for Person. Services for the Person Carrier is available from the Person Agent.

MotherId
integer<int32>

ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment. However, if 0 and assoc_id != reg_id then this is an assigned appointment, indicated vt type = kBooking

Priority
object

Carrier object for Priority. Services for the Priority Carrier is available from the List Agent.

Private
enum<string>

The confidentiality of appointments is shown as different types of “private” on the appointment. For an updated list of “private” types, see the database manual.

Available options:
Public,
PrivateUser,
PrivateGroup
Project
object

Carrier object for Project. Services for the Project Carrier is available from the Project Agent.

Type
enum<string>

The different types of appointment, if the appointment is supposed to be shown in the diary or checklist, or if it's a document. See the different types of appointments in the database manual.

Available options:
Unknown,
inDiary,
inChecklist,
Note,
Document,
SavedReport,
BookingForDiary,
BookingForChecklist,
MergeDraft,
MergeFinal
UpdatedDate
string<date-time>

Updated date in UTC.

Completed
enum<string>

Appointment Completed state. This property is the part of the Status property that is the completed state. Could be three state if the three state user preference is set.

Available options:
Unknown,
NotStarted,
Started,
Completed

Number of active links to sale, document, appointment.

List of all elements linked to the appointment.

AlarmLeadTime
string

Alarm lead time.

HasAlarm
boolean

Does this appointment have an alarm

ColorIndex
integer<int32>

Appointment colour, used only in Japanese versions. Western versions take colour from Task

IsFree
boolean

True if free, false if busy

IsAlldayEvent
boolean

True if all day event

LagTime
string

as leadtime, but after the end - time blocked for travel etc.

LeadTime
string

Time blocked (minutes) BEFORE starttime

Location
string

Location for appointment, defaulted from invited resource of type place and other rules, but you can write anything you want here

RejectCounter
integer<int32>

How many invitees have rejected this appointment

RejectReason
string

Why was this booking or assignment rejected, the RejectReason list is a source of suggestions but you can write anything here Use MDO List name "rejectReason" to get list items.

Recurrence
object

Class representing the recurrence of an appointment booking

Participants
object[]

List of id's of the participants to this appointment.

AssignmentStatus
enum<string>

Status if this appointment is in the process of being assigned to someone else

Available options:
Unknown,
None,
Assigning,
Seen,
Declined
InvitationStatus
enum<string>

Status if this appointment represents an invitation

Available options:
Unknown,
None,
Accepted,
Hidden,
Invitation,
Moved,
Seen,
MovedSeen,
Declined,
Cancelled
BookingType
enum<string>

The type of booking the appointment represents

Available options:
Unknown,
None,
Owner,
Participant
ActiveDate
string<date-time>

The date to be used for searching & showing

HasConflict
boolean

Does the appointment overlap with another appointment in the user's diary?

AssignedBy
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

MotherAssociate
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

Task
object

Carrier object for TaskListItem. Services for the TaskListItem Carrier is available from the Appointment Agent.

PreferredTZLocation
integer<int32>

Appointments preferred timezone location.

PreferredTZLocationData
object
Sale
object

Carrier object for Sale. Services for the Sale Carrier is available from the Sale Agent.

SuggestedAppointmentId
integer<int32>

Suggested guide item that this appointment is an instance of (Note: NOT VALID for document-type appointments, they have their own link)

IsMileStone
boolean

Is this appointment a milestone?

CautionWarning
enum<string>

Status field to indicate appointments that have some sort of problem

Available options:
OK,
NotInSync,
NotNotifiedByEmail,
RecurrencePatternNotSupported,
IncomingRecurrenceChangeNotSupported,
ExternalParticipantsDateTimeMismatch
OwnedExternally
enum<string>

Set if an external system owns this appointment.

Available options:
None,
Other,
Outlook,
Google
JoinVideomeetUrl
string

Blank when not a video meeting. Filled with Join Meeting URL when created.

CentralserviceVideomeetId
string

GUID for video meeting in central services – this is set when we create meetings from SuperOffice. It is blank for incoming meetings created from inbox.

UserDefinedFields
object

Deprecated: Use {SuperOffice.CRM.Services.AppointmentEntity.CustomFields} instead. Dictionary of user defined field data. The key string is the ProgId of the UdefField, or if the ProgId is empty it is a string of the format "SuperOffice:[UdefFieldIdentity]", e.g. "SuperOffice:1234"

ExtraFields
object

Deprecated: Use {SuperOffice.CRM.Services.AppointmentEntity.CustomFields} instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc.

CustomFields
object

Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin. Custom fields combines user defined fields and extra fields into one bucket. The individual {SuperOffice.CRM.Services.AppointmentEntity.ExtraFields} and UserDefinedFields properties are deprecated in favor of this combined collection.

PublishEventDate
string<date-time>

Publish event date

PublishTo
string<date-time>

Publication valid to (inclusive)

PublishFrom
string<date-time>

Publication valid from (inclusive)

IsPublished
boolean

Publication is published

VisibleFor
object[]

The set of users or groups the record is visible for

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.