Skip to content

Create Appointment

POST /appointment

To create an appointment, you must provide the OrderID that refers to a non-cancelled, non-terminated Order.

The ValidFrom and ValidTo times refer to the time window you received in the response from the Search Available Time Slots API. The timestamps must match exactly as provided in that API and will in almost all cases correspond to a :00, :15, :30 minute marker.

json
{
   "category":"Install",
   "relatedEntity":[
      {
         "id":"123456789",
         "@referredType":"ProductOrder"
      }
   ],
   "relatedParty":[
      {
         "role":"contactPerson",
         "name":"Kate Smith",
         "title":"Miss",
         "@referredType":"individual",
         "contactMedium":[
            {
               "type":"phone",
               "value":"6788484526",
               "preferred":true
            }
         ]
      }
   ],
   "externalId":"M1234567890",
   "validFor":{
      "startDateTime":"1715005423",
      "endDateTime":"1715005423"
   },
   "description":"ADDITIONAL INFO FROM ISP",
   "note":{
      "text":"ADDITIONAL NOTES"
   }
}