This API Call will be deprecated from 1st December 2016 due to IRTP changes in the system. Modifying a Contact is no longer allowed and only New Contacts can be created and associated with a domain.
Description
Modifies the details of the specified Contact.
Parameters
Name | Data Type | Required / Optional | Description |
---|---|---|---|
auth-userid | Integer | Required | Authentication Parameter |
api-key | String | Required | Authentication Parameter |
contact-id | Integer | Required | Contact ID of the Contact whose details you want to modify |
name | String | Required | Name of Contact |
company | String | Required | Name of the Company |
String | Required | Email address of the Contact | |
address-line-1 | String | Required | First line of address of the Contact |
city | String | Required | Name of the City |
zipcode | String | Required | ZIP code |
phone-cc | String | Required | Telephone number Country Code |
phone | String | Required | Telephone number |
country | String | Required |
Country code as per ISO 3166-1 alpha-2 |
address-line-2 | String | Optional | Second line of address of the Contact |
address-line-3 | String | Optional | Third line of address of the Contact |
state | String | Optional | Name of the State |
fax-cc | String | Optional | Fax number Country Code |
fax | String | Optional | Fax number |
-
You will encounter the below error message in case the Contact is associated with one or more suspended domain name(s):
AttentionChange of this contact is not allowed as it is associated with a suspended domain
-
Unused Contacts (except Default Contacts) that were created more than six months ago are archived. Details of archived Contacts cannot be modified using this API call.
Additional Information
HTTP Method
POST
Example Test URL Request
https://test.httpapi.com/api/contacts/modify.json?auth-userid=0&api-key=key&contact-id=0&name=abc&company=company&email=dummy@abc.com&address-line-1=address1&address-line-2=address2&city=city&country=nn&zipcode=0&phone-cc=0&phone=0
Response
Returns a hash map containing the below details:
-
Contact ID (entityid)
-
Action Type (actiontype)
-
Description of the Contact Modification Action (actiontypedesc)
-
Action ID of the Contact Modification Action (eaqid)
-
Contact Modification Action Status (actionstatus)
-
Description of the Contact Modification Action Status (actionstatusdesc)
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.