PATCH api/sitecontact/{id}

The purpose of this API is update selected details of the specified site Contact.

Error Messages
  • 401/Unauthorized - Invalid company permissions
  • 404/Not Found - Site with ID x not found - Specified ID is not assigned to a Site Contact

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id The unique identifier for the Site Contact being queried. integer

Required

Body Parameters

SiteContactModify
NameDescriptionTypeAdditional information
SiteID The Site ID the contact belongs to integer

None.
Title The contact's title string

String length: inclusive between 0 and 4
Surname The contact's first name string

String length: inclusive between 0 and 40
Christian The contacts secodn name string

Required

String length: inclusive between 0 and 40
DDI The contact's DDI string

String length: inclusive between 0 and 34
Mobile The contact's mobile number string

Data type: PhoneNumber

String length: inclusive between 0 and 17
Email The contact's email string

Required

Matching regular expression pattern: ^([a-zA-Z0-9_\-\.]+)@((\[?[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\]?)|(([a-zA-Z0-9\-]+\.)+)([a-zA-Z0-9]{2,63}))$

String length: inclusive between 0 and 255
Extension The contact's email string

String length: inclusive between 0 and 5
MainContact Specify whether the contact is the main contact boolean

None.
PreventSDeskNotify Prohibit incident emails boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "SiteID": 1,
  "Title": "sample string 2",
  "Surname": "sample string 3",
  "Christian": "sample string 4",
  "DDI": "sample string 5",
  "Mobile": "sample string 6",
  "Email": "sample string 7",
  "Extension": "sample string 8",
  "MainContact": true,
  "PreventSDeskNotify": true
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version Version

None.
Content HttpContent

None.
StatusCode HttpStatusCode

None.
ReasonPhrase string

None.
Headers Collection of Object

None.
RequestMessage HttpRequestMessage

None.
IsSuccessStatusCode boolean

None.