Objects

Update an appointment property

Update a single appointment property by appointment ID.

Overview

Use this endpoint to replace one property value on an existing appointment. It requires public api oauth access token authentication and the crm.appointments.write scope.

PATCH/api/crm/objects/appointments/{appointmentId}

cURL

PATCH

bash

curl --request PATCH \  --url 'https://crm.notifyy.io/api/crm/objects/appointments/55' \  --header 'Authorization: Bearer nfy_public_api_access_token' \  --header 'Content-Type: application/json' \  --data '{  "internal_name": "name",  "value": "Updated demo call"}'

Authorization

Public API OAuth access token

crm.appointments.write

Sample Request Body

json

{  "internal_name": "name",  "value": "Updated demo call"}

Sample Response

json

{  "success": true,  "message": "Property updated successfully",  "data": null}

Status Codes

Code	Description
200	Property was updated.

Headers

AuthorizationstringRequired

Public API OAuth bearer token.

Example: Bearer nfy_public_api_access_token

Content-TypestringRequired

Request body media type.

Example: application/json

Object	Description
Authorization string	RequiredPublic API OAuth bearer token. Example: Bearer nfy_public_api_access_token
Content-Type string	RequiredRequest body media type. Example: application/json

Path parameters

appointmentIdintegerRequired

Appointment ID.

Example: 55

Object	Description
appointmentId integer	RequiredAppointment ID. Example: 55

Request body

internal_namestringRequired

Property internal name to update.

Example: name

valueanyOptional

Scalar property value.

Example: Updated demo call

Object	Description
internal_name string	RequiredProperty internal name to update. Example: name
value any	OptionalScalar property value. Example: Updated demo call

Response fields

datanull

No response payload is returned for a successful property update.

Object	Description
data null	No response payload is returned for a successful property update.