v1

latestSwagger 2.02026-08-043765135.6 KB
appointments

Update Appointment

Update a specific appointment.

patch/appointments/{id}

Path parameters

idstring uuid required

Primary UUID in the path

Query parameters

mockboolean

Return mock data

Request body

Example request

{
  "data": {
    "type": "appointments",
    "attributes": {
      "scheduledStartDateTime": "2018-02-03T10:30:00Z",
      "scheduledEndDateTime": "2018-02-03T10:30:00Z",
      "actualStartDateTime": "2018-02-03T10:30:00Z",
      "actualEndDateTime": "2018-02-03T10:30:00Z",
      "resources": [
        {
          "type": "customers",
          "id": "00000000-0000-0000-0000-000000000067"
        }
      ]
    }
  }
}

Response

Return a single data response

Example response

{
  "data": {
    "attributes": {
      "createdAt": "2018-02-03T10:30:00Z",
      "updatedAt": "2018-02-03T10:30:00Z",
      "scheduledStartDateTime": "2018-02-03T10:30:00Z",
      "scheduledEndDateTime": "2018-02-03T10:30:00Z",
      "actualStartDateTime": "2018-02-03T10:30:00Z",
      "actualEndDateTime": "2018-02-03T10:30:00Z"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "bdb88373-bf66-4bfc-a4f8-3a35be5c2f9c"
        }
      },
      "resources": {
        "data": [
          {
            "type": "customers",
            "id": "00000000-0000-0000-0000-000000000069"
          }
        ]
      },
      "answers": {
        "data": [
          {
            "type": "answers",
            "id": "00000000-0000-0000-0000-000000000069"
          }
        ]
      }
    }
  }
}