v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Activity

Appointments.create

Creates new Appointment

post/entities/Appointments

Query parameters

validation-levelinteger

Specify validation level of Appointment on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Response

Creation confirmation. Returns created Appointment

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "active_reminder": "2019-01-01T00:00:00",
    "media_transcription_id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "activity_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
    "description": "string",
    "end_date": "2019-01-01T00:00:00",
    "location": "string",
    "occurence_date": "2019-01-01T00:00:00",
    "organizer": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "recurrence_master_id": "01234567-abcd-dcba-ffff-000000000000",
    "recurrence_rule": "string",
    "recurrence_tzid": "string",
    "schedule_id": "01234567-abcd-dcba-ffff-000000000000",
    "schedule_tzid": "string",
    "start_date": "2019-01-01T00:00:00",
    "subject": "string",
    "table_name": "string",
    "unit_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1,
    "status": 1,
    "exchange_entity_id": "string",
    "gapi_entity_id": "string",
    "o365_entity_id": "string",
    "formatted_name": "string",
    "modified_by_user": "2019-01-01T00:00:00"
  }
}