COcoevera
Activity

AppointmentContactInviteesRelations.batch_create_or_update

Creates or updates AppointmentContactInviteesRelation records in one request: an item with an id updates that record, an item without one creates a new record.

post/entities/AppointmentContactInviteesRelations/batch-modify

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.

rollback-method0 | 1

0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item.

Request body

appointment_idstring uuid

Id of the appointment the contact has been invited to.

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: 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.

idstring uuid

ID of object to update.

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

Result per item, in request order: the id of the created or updated record, or the error.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": [
    {
      "http_status": 400,
      "code": 117,
      "name": "ERROR_PARAMETER_INVALID"
    }
  ]
}

Changes

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