Difference between revisions of "API:Contact:Update"

From docs
Jump to: navigation, search
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
  
== Update Contact ==
+
== [[API]] » Update Contact ==
  
 
'''URL:''' <nowiki>https://app.callproof.com/api/contact/update/</nowiki>
 
'''URL:''' <nowiki>https://app.callproof.com/api/contact/update/</nowiki>
Line 8: Line 8:
 
'''Required Fields:'''
 
'''Required Fields:'''
  
* '''''key''''' - API Key
+
* '''''api_key[key]''''' - API Key
* '''''secret''''' - API Key Secret
+
* '''''api_key[secret]''''' - API Key Secret
 
* '''''contact[id]''''' - Contact ID
 
* '''''contact[id]''''' - Contact ID
  
 
'''Optional Fields:'''
 
'''Optional Fields:'''
  
 +
* '''''contact[rep_ids][]''''' - Array of Contact Rep IDs (use an empty array [] to remove all reps)
 +
* '''''contact[contact_phones][]''''' - Array of Contact Phones
 
* '''''contact[contact_type]''''' - Contact custom contact type (https://app.callproof.com/contact_types/)
 
* '''''contact[contact_type]''''' - Contact custom contact type (https://app.callproof.com/contact_types/)
 
* '''''contact[company_name]''''' - Contact company name
 
* '''''contact[company_name]''''' - Contact company name
Line 35: Line 37:
 
* '''''contact[last_contacted]''''' - Contact last contacted date/time (e.g. '2014-08-10 12:34:56')
 
* '''''contact[last_contacted]''''' - Contact last contacted date/time (e.g. '2014-08-10 12:34:56')
 
* '''''contact[default_phone][phone_number]''''' - Contact default phone number (e.g. 6158675309)
 
* '''''contact[default_phone][phone_number]''''' - Contact default phone number (e.g. 6158675309)
* '''''contact[default_phone][type]''''' - Contact default phone type (cell, home, office, fax, headquartes, other)
+
* '''''contact[default_phone][phone_type]''''' - Contact default phone type (cell, home, office, fax, headquartes, other)
  
 
'''Data Returned:'''
 
'''Data Returned:'''

Latest revision as of 22:21, 6 January 2015

API » Update Contact

URL: https://app.callproof.com/api/contact/update/

Method: POST

Required Fields:

  • api_key[key] - API Key
  • api_key[secret] - API Key Secret
  • contact[id] - Contact ID

Optional Fields:

  • contact[rep_ids][] - Array of Contact Rep IDs (use an empty array [] to remove all reps)
  • contact[contact_phones][] - Array of Contact Phones
  • contact[contact_type] - Contact custom contact type (https://app.callproof.com/contact_types/)
  • contact[company_name] - Contact company name
  • contact[first_name] - Contact first name
  • contact[last_name] - Contact last name
  • contact[title] - Contact title (e.g. CEO)
  • contact[email] - Contact email address (e.g. fred@aol.com)
  • contact[account] - Contact account number (e.g. 123456)
  • contact[invoice] - Contact invoice number (e.g. 123456)
  • contact[website] - Contact website URL (e.g. http://example.com/)
  • contact[address] - Contact address
  • contact[address2] - Contact address2
  • contact[city] - Contact city
  • contact[state] - Contact two letter state name (e.g. TN, FL, CA)
  • contact[zip] - Contact zip code
  • contact[country] - Contact country
  • contact[latitude] - Contact latitude
  • contact[longitude] - Contact longitude
  • contact[unknown] - Set to '1' if Contact is unknown
  • contact[do_not_sms] - Set to '1' if Contact should not be sent SM messages
  • contact[last_contacted] - Contact last contacted date/time (e.g. '2014-08-10 12:34:56')
  • contact[default_phone][phone_number] - Contact default phone number (e.g. 6158675309)
  • contact[default_phone][phone_type] - Contact default phone type (cell, home, office, fax, headquartes, other)

Data Returned:

  • results - Contact as provided
  • errors - Array of errors produced by the request
  • code - HTTP request status