Appointments.batch_create_or_update

Create or update an batch of Appointments

Request

Query Params

validation-level

integer <int32>

optional

Specify validation level of Appointments on change. 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.

rollback-method

integer <int32>

optional

Specify rollback method for Appointments. 0 - rollback all, 1 - rollback only failed records.

Body Params application / json

array of:

media_transcription_id

string <uuid>

optional

Example:

01234567-abcd-dcba-ffff-000000000000

activity_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

currency_exchange_rates_list_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

description

string

optional

Multi-line text input field.

Example:

string

duration

number <double>

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

4.32

end_date

string <date-time>

optional

Datetime information.

Example:

2019-01-01T00:00:00

invitees_can_edit

boolean

optional

Boolean value.

Example:

false

is_recurrence_active

boolean

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

false

is_recurrence_exception

boolean

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

false

location

string

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

meeting_url

object

optional

Field containing json.

occurence_date

string <date-time>

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

2019-01-01T00:00:00

organizer

string

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

owner_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

recurrence_master_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

recurrence_rule

string

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

recurrence_tzid

string

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

schedule_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

schedule_tzid

string

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

start_date

string <date-time>

optional

Datetime information.

Example:

2019-01-01T00:00:00

subject

string

optional

Name of the entity and its default text representation.

Example:

string

unit_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

account_relations

array [object {1}]

optional

Relations to Accounts.

string <uri>

optional

contact_relations

array [object {1}]

optional

Relations to Contacts.

string <uri>

optional

lead_relations

array [object {1}]

optional

Relations to Leads.

string <uri>

optional

opportunity_relations

array [object {1}]

optional

Relations to Opportunitys.

string <uri>

optional

project_relations

array [object {1}]

optional

Relations to Projects.

string <uri>

optional

quote_relations

array [object {1}]

optional

Relations to Quotes.

string <uri>

optional

custom_entity_relations

array [object {1}]

optional

Relations to CustomEntitys.

string <uri>

optional

invitees_contacts

array [object {1}]

optional

Relations to AppointmentContactInviteesRelations.

string <uri>

optional

invitees_clients

array [object {1}]

optional

Relations to Clients.

string <uri>

optional

exchange_entity_id

string

optional

Example:

string

gapi_entity_id

string

optional

Example:

string

o365_entity_id

string

optional

Example:

string

documents

array [object {1}]

optional

Relations to CloudObjects.

string <uri>

optional

comments

array [object {1}]

optional

Relations to ActivityComments.

string <uri>

optional

string <uuid>

optional

ID of object to update.

Example

[
    {
        "media_transcription_id": "01234567-abcd-dcba-ffff-000000000000",
        "activity_type_id": "01234567-abcd-dcba-ffff-000000000000",
        "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
        "description": "string",
        "duration": "4.32",
        "end_date": "2019-01-01T00:00:00",
        "invitees_can_edit": false,
        "is_recurrence_active": false,
        "is_recurrence_exception": false,
        "location": "string",
        "meeting_url": {},
        "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",
        "unit_id": "01234567-abcd-dcba-ffff-000000000000",
        "revision": 1,
        "account_relations": [
            {
                "id": "http://example.com"
            }
        ],
        "contact_relations": [
            {
                "id": "http://example.com"
            }
        ],
        "lead_relations": [
            {
                "id": "http://example.com"
            }
        ],
        "opportunity_relations": [
            {
                "id": "http://example.com"
            }
        ],
        "project_relations": [
            {
                "id": "http://example.com"
            }
        ],
        "quote_relations": [
            {
                "id": "http://example.com"
            }
        ],
        "custom_entity_relations": [
            {
                "id": "http://example.com"
            }
        ],
        "invitees_contacts": [
            {
                "id": "http://example.com"
            }
        ],
        "invitees_clients": [
            {
                "id": "http://example.com"
            }
        ],
        "exchange_entity_id": "string",
        "gapi_entity_id": "string",
        "o365_entity_id": "string",
        "documents": [
            {
                "id": "http://example.com"
            }
        ],
        "comments": [
            {
                "id": "http://example.com"
            }
        ],
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
]

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/entities/Appointments/batch-modify' \
--header 'Content-Type: application / json' \
--data-raw '[
    {
        "media_transcription_id": "01234567-abcd-dcba-ffff-000000000000",
        "activity_type_id": "01234567-abcd-dcba-ffff-000000000000",
        "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
        "description": "string",
        "duration": "4.32",
        "end_date": "2019-01-01T00:00:00",
        "invitees_can_edit": false,
        "is_recurrence_active": false,
        "is_recurrence_exception": false,
        "location": "string",
        "meeting_url": {},
        "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",
        "unit_id": "01234567-abcd-dcba-ffff-000000000000",
        "revision": 1,
        "account_relations": [
            {
                "id": "http://example.com"
            }
        ],
        "contact_relations": [
            {
                "id": "http://example.com"
            }
        ],
        "lead_relations": [
            {
                "id": "http://example.com"
            }
        ],
        "opportunity_relations": [
            {
                "id": "http://example.com"
            }
        ],
        "project_relations": [
            {
                "id": "http://example.com"
            }
        ],
        "quote_relations": [
            {
                "id": "http://example.com"
            }
        ],
        "custom_entity_relations": [
            {
                "id": "http://example.com"
            }
        ],
        "invitees_contacts": [
            {
                "id": "http://example.com"
            }
        ],
        "invitees_clients": [
            {
                "id": "http://example.com"
            }
        ],
        "exchange_entity_id": "string",
        "gapi_entity_id": "string",
        "o365_entity_id": "string",
        "documents": [
            {
                "id": "http://example.com"
            }
        ],
        "comments": [
            {
                "id": "http://example.com"
            }
        ],
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
]'

Responses

🟢200OK

application/json

Creation confirmation. Returns a list of created / updated Appointments

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

array [oneOf]

optional

string <uuid>

optional

And ID of created / updated entity.

object (Error)

optional

Example

{
    "success": true,
    "data": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
}

🔴500Server Error