View source

=PUT /accounts/''{accountNumber}''/dedicatedServers/''{serverId}''/ipAddresses/''{ipAddr}''/monitoring/notificationGroups/''{groupId}''=
'''<span style="color:red">This API call is deprecated!</span>'''

Update a contact

__TOC__

== Request ==
<code>PUT /accounts/''{accountNumber}''/dedicatedServers/''{serverId}''/ipAddresses/''{ipAddr}''/monitoring/notificationGroups/''{groupId}''/contacts/''{contactId}''</code>

==== Request Parameters ====
; accountNumber - ''string''
; serverId - ''string''
; ipAddr - ''string''
; groupId - ''string''
: Id of the notification group
; contactId - ''string''
: Id of the contact in this notification group

=== URI Parameters ===
None

=== Request Headers ===
; Authorization
: Specify the '''Authorization''' header when requesting details for an order that was already submitted. Follow the instructions for API [[Authentication]].

; Content-Type
: Required. Set this header to <code>application/json; charset=UTF-8</code>

=== Request Body ===
 <nowiki>
{ 
   "contact": {
      "name": "{contact_name}",
      "type": "{contact_type}", 
      "address": "{contact_address}",
      "onTime": {contact_ontime}, 
      "offTime": {contact_offtime}
   }
}
</nowiki>

==== Parameters ====
; name - ''string''
: Descriptive name for this contact.

; type - ''EMAIL/PAGER''

; address - ''string''
: Email or pager number

; onTime - ''int''

; offTime - ''int''

== Response ==

=== Status Code ===
;200 OK
: Success.

;400 Bad Request
: Invalid user input

;401 Unauthorized
: This server could not verify that you are authorized to access the document you requested.  Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required

;404 Not Found
:  The resource requested is not found

=== Response Body ===
 <nowiki>
{
   "contact": {
      "name": "{contact_name}", 
      "onTime": {contact_ontime}, 
      "links": [
         {
            "href": "{{APIBaseURL}}/contactgroups/{contactgroup_id}/contacts/{contact_id}/", "rel": "self"
         }
      ], 
      "address": "{contact_address}", 
      "offTime": {contact_offtime}, 
      "type": "{contact_type}", 
      "id": {contact_id}
   }
}
</nowiki>

==== Parameters ====
; id - ''string''
: Unique identifier for this contact.

; name - ''string''
: Descriptive name for this contact.

; type - ''EMAIL/PAGER''

; address - ''string''
: Email or pager number

; onTime - ''int''

; offTime - ''int''

; links - ''list''
: [[Hypermedia]] for this resource.

== Examples ==
=== Successful deletion ===
'''Request'''

<code>PUT {{APIBaseURL}}/accounts/test-358536378/dedicatedServers/test-358536378-000001338fd091e/ipAddresses/11.22.33.44/monitoring/notificationGroups/186/contacts/1556</code>
 <nowiki>
{
   "contact": {
      "name": "test_contact_updated", 
      "type": "EMAIL", 
      "address": "updated_abc@abc.com", 
      "onTime": 50400, 
      "offTime": 11600
   }
}
</nowiki>

'''Response'''
:''OK (200)'':
 <nowiki>
{
   "contact": {
	"onTime": 50400,
	"name": "test_contact_updated",
	"address": "updated_abc@abc.com",
	"offTime": 11600,
	"type": "EMAIL",
	"id": 1556
   },
   "links": [{
	"href": "{{APIBaseURL}}/accounts/test-358536378/dedicatedServers/test-358536378-000001338fd091e/ipAddresses/11.22.33.44/monitoring/notificationGroups/186/contacts/1556",
	"rel": "self"
   }]
}
</nowiki>

=== Wrong input ===
'''Request'''

<code>PUT {{APIBaseURL}}/accounts/test-358536378/dedicatedServers/test-358536378-000001338fd091e/ipAddresses/11.22.33.44/monitoring/notificationGroups/186/contacts/1556</code
 <nowiki>
{
   "contact": {
      "name": "test_contact_updated", 
      "type": "FAX", 
      "address": "updated_abc.com", 
      "onTime": 50400, 
      "offTime": 21600
   }
}
</nowiki>

'''Response'''
:''Bad Request (400)'': 
 <nowiki>
{
   "badRequest": {
      "message": "POST data error", 
      "code": 400, 
      "details": {
         "contact.address": "Invalid email address", 
         "contact.type": "\"FAX\" is not one of EMAIL"
      }
   }
}
</nowiki>

== See also ==
* [[Monitoring|Monitoring API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Dedicated Server Monitoring API]]