Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Activity

AppointmentContactInviteesRelations.update

Modifies AppointmentContactInviteesRelation or AppointmentContactInviteesRelations with given id(s)

patch/entities/AppointmentContactInviteesRelations/{id}

Path parameters

idstring uuid required

ID of AppointmentContactInviteesRelation to update

Query parameters

validation-levelinteger

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

Request body

appointment_idstring uuid

Id of the appointment.

contact_idstring uuid

Id of the matched contact.

emailstring

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 (e.g. as a contact, free-form email, schedule booking).

Integer enum value: 0 - Standard, 1 - Scheduled

last_namestring

Family name of the invitee, when supplied.

response0 | 1 | 2

Invitee response (e.g. Accepted, Tentative, Declined, Pending).

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

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "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

Modification confirmation. Returns resulting AppointmentContactInviteesRelation

successboolean

True when response 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
  }
}