COcoevera
Activity

AppointmentContactInviteesRelations.create

Creates a AppointmentContactInviteesRelation record.

post/entities/AppointmentContactInviteesRelations

Request

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

modifiedstring date-time

Last modification time.

createdstring date-time

Creation time.

appointment_idstring uuid required

Id of the appointment the contact has been invited to.

contact_idstring uuid

Id of the matched contact.

emailstring required

Email address of the invitee. Required and used as the natural key for the link.

first_namestring

Given name of the invitee, when supplied.

invitee_type0 | 1

How the invitee was added: invited directly on the appointment (Standard), or the person who booked it through an appointment schedule (Scheduled).

Integer enum value: 0 - Standard, 1 - Scheduled

last_namestring

Family name of the invitee, when supplied.

response0 | 1 | 2

Response of the invitee to the appointment invitation: NoResponse, Accepted or Rejected.

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

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "modified": "2019-01-01T00:00:00",
  "created": "2019-01-01T00:00:00",
  "appointment_id": "01234567-abcd-dcba-ffff-000000000000",
  "contact_id": "01234567-abcd-dcba-ffff-000000000000",
  "email": "string",
  "first_name": "string",
  "last_name": "string",
  "revision": 1
}

Response

The created AppointmentContactInviteesRelation record.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "appointment_id": "01234567-abcd-dcba-ffff-000000000000",
    "contact_id": "01234567-abcd-dcba-ffff-000000000000",
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "revision": 1
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.