AppointmentContactInviteesRelations.create

Creates new AppointmentContactInviteesRelation

Request

Query Params

validation-level

integer <int32>

optional

Specify validation level of AppointmentContactInviteesRelation 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

appointment_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

contact_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

string

required

Email address.

Example:

string

first_name

string

optional

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

Example:

string

invitee_type

enum<integer>

optional

Integer enum value: 0 - Standard, 1 - Scheduled

Allowed values:

Example:

last_name

string

optional

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

Example:

string

response

enum<integer>

optional

Integer enum value: 0 - NoResponse, 1 - Accepted, 2 - Rejected

Allowed values:

012

Example:

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

Example

{
    "appointment_id": "01234567-abcd-dcba-ffff-000000000000",
    "contact_id": "01234567-abcd-dcba-ffff-000000000000",
    "email": "string",
    "first_name": "string",
    "invitee_type": 0,
    "last_name": "string",
    "response": 0,
    "revision": 1
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

Creation confirmation. Returns created AppointmentContactInviteesRelation

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (AppointmentContactInviteesRelation)

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

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

appointment

string <uri>

required

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.

contact

string <uri>

optional

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

appointment_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

contact_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

string

required

Email address.

Example:

string

first_name

string

optional

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

Example:

string

invitee_type

enum<integer>

optional

Integer enum value: 0 - Standard, 1 - Scheduled

Allowed values:

Example:

last_name

string

optional

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

Example:

string

response

enum<integer>

optional

Integer enum value: 0 - NoResponse, 1 - Accepted, 2 - Rejected

Allowed values:

012

Example:

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

Example

{
    "success": true,
    "data": {
        "is_delete_protected": false,
        "id": "01234567-abcd-dcba-ffff-000000000000",
        "is_deleted": false,
        "modified": "2019-01-01T00:00:00",
        "created": "2019-01-01T00:00:00",
        "appointment": "http://example.com",
        "contact": "http://example.com",
        "appointment_id": "01234567-abcd-dcba-ffff-000000000000",
        "contact_id": "01234567-abcd-dcba-ffff-000000000000",
        "email": "string",
        "first_name": "string",
        "invitee_type": 0,
        "last_name": "string",
        "response": 0,
        "revision": 1
    }
}

🔴500Server Error