Appointments.create - PipelinerCRM

Creates new Appointment

Request

Query Params

validation-level

integer <int32>

optional

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.

Body Params application / json

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>

required

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>

required

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

required

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

reminder

object

optional

Relation to AppointmentReminder, see: 'createAppointmentReminderInput' object for properties.

string <uri>

optional

documents

array [object {1}]

optional

Relations to CloudObjects.

string <uri>

optional

comments

array [object {1}]

optional

Relations to ActivityComments.

string <uri>

optional

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"
        }
    ],
    "reminder": {
        "id": "http://example.com"
    },
    "documents": [
        {
            "id": "http://example.com"
        }
    ],
    "comments": [
        {
            "id": "http://example.com"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/entities/Appointments' \
--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"
        }
    ],
    "reminder": {
        "id": "http://example.com"
    },
    "documents": [
        {
            "id": "http://example.com"
        }
    ],
    "comments": [
        {
            "id": "http://example.com"
        }
    ]
}'

Responses

🟢201Created

application/json

Creation confirmation. Returns created Appointment

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (Appointment)

optional

is_delete_protected

boolean

read-onlyrequired

Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity.

Example:

01234567-abcd-dcba-ffff-000000000000

active_reminder

string <date-time>

optional

Example:

2019-01-01T00:00:00

media_transcription_id

string <uuid>

optional

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

activity_type

string <uri>

required

Relation to AppointmentType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AppointmentType' object for properties.

currency_exchange_rates_list

string <uri>

optional

Relation to CurrencyExchangeRatesList. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CurrencyExchangeRatesList' object for properties.

owner

string <uri>

required

Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties.

recurrence_master

string <uri>

optional

Relation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties.

schedule

string <uri>

optional

Relation to AppointmentSchedule. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AppointmentSchedule' object for properties.

unit

string <uri>

required

Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties.

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>

required

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>

required

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

required

Name of the entity and its default text representation.

Example:

string

table_name

string

read-onlyrequired

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

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:

status

enum<integer>

required

Integer enum value: 1 - NotStarted, 2 - InProgress, 3 - Waiting, 4 - Completed, 5 - Deferred, 6 - Canceled

Allowed values:

123456

Example:

account_relations

array[string <uri>]

optional

Relations to Accounts.

contact_relations

array[string <uri>]

optional

Relations to Contacts.

lead_relations

array[string <uri>]

optional

Relations to Leads.

opportunity_relations

array[string <uri>]

optional

Relations to Opportunitys.

project_relations

array[string <uri>]

optional

Relations to Projects.

quote_relations

array[string <uri>]

optional

Relations to Quotes.

custom_entity_relations

array[string <uri>]

optional

Relations to CustomEntitys.

invitees_contacts

array[string <uri>]

optional

Relations to AppointmentContactInviteesRelations.

invitees_clients

array[string <uri>]

optional

Relations to Clients.

exchange_entity_id

string

optional

Example:

string

gapi_entity_id

string

optional

Example:

string

o365_entity_id

string

optional

Example:

string

has_3rd_party_mapping

boolean

required

Example:

false

reminder

string <uri>

optional

Relation to AppointmentReminder. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AppointmentReminder' object for properties.

documents

array[string <uri>]

optional

Relations to CloudObjects.

comments

array[string <uri>]

optional

Relations to ActivityComments.

formatted_name

string

required

Example:

string

recurrence

object

optional

modified_by_user

string <date-time>

optional

Example:

2019-01-01T00:00:00

Example

{
    "success": true,
    "data": {
        "is_delete_protected": false,
        "id": "01234567-abcd-dcba-ffff-000000000000",
        "active_reminder": "2019-01-01T00:00:00",
        "media_transcription_id": "01234567-abcd-dcba-ffff-000000000000",
        "is_deleted": false,
        "modified": "2019-01-01T00:00:00",
        "created": "2019-01-01T00:00:00",
        "activity_type": "http://example.com",
        "currency_exchange_rates_list": "http://example.com",
        "owner": "http://example.com",
        "recurrence_master": "http://example.com",
        "schedule": "http://example.com",
        "unit": "http://example.com",
        "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",
        "table_name": "string",
        "unit_id": "01234567-abcd-dcba-ffff-000000000000",
        "revision": 1,
        "status": 1,
        "account_relations": [
            "http://example.com"
        ],
        "contact_relations": [
            "http://example.com"
        ],
        "lead_relations": [
            "http://example.com"
        ],
        "opportunity_relations": [
            "http://example.com"
        ],
        "project_relations": [
            "http://example.com"
        ],
        "quote_relations": [
            "http://example.com"
        ],
        "custom_entity_relations": [
            "http://example.com"
        ],
        "invitees_contacts": [
            "http://example.com"
        ],
        "invitees_clients": [
            "http://example.com"
        ],
        "exchange_entity_id": "string",
        "gapi_entity_id": "string",
        "o365_entity_id": "string",
        "has_3rd_party_mapping": false,
        "reminder": "http://example.com",
        "documents": [
            "http://example.com"
        ],
        "comments": [
            "http://example.com"
        ],
        "formatted_name": "string",
        "recurrence": {},
        "modified_by_user": "2019-01-01T00:00:00"
    }
}

🔴500Server Error