Nested Objects API Information

Nested Objects

Nested objects can be created, updated or deleted through the parent object's API (contacts, accounts, etc). Updating requires the ID of the nested object be specified. If ID is a blank string, a new record will be created. To delete a nested object, simply pass _destroy=1 as a parameter.

Below is the schema information for several nested objects. 

Email Addresses

  • id ID of this record, required to make updates, set to blank for new
  • address (required) - email address
  • _destroy - set to 1 to delete this record

Phone Numbers

  • id ID of this record, required to make updates, set to blank for new
  • number (required) - actual phone #
  • extension - e.g., ext 3
  • phone_number_type - Main, Mobile, Fax, Work, Home, Skype
  • _destroy - set to 1 to delete this record

Websites

  • id ID of this record, required to make updates, set to blank for new
  • url (required)
  • _destroy - set to 1 to delete this record

Addresses

  • id ID of this record, required to make updates, set to blank for new
  • address1
  • address2
  • city
  • state - abbreviated state name (e.g., TX, NE, etc.)
  • zip_code - postal code
  • address_typeMain, Work, Home, or Other
  • _destroy - set to 1 to delete this record

Custom Fields (values)

  • id ID of this record, required to make updates, set to blank for new
  • custom_field_id (required) - ID of the Custom Field for this custom field value
  • value (required)- Value for this custom field
  • _destroy - set to 1 to delete this record

Need help?

If you're having any problems with getting the above set up working, please do not hesitate to call or email support with any questions.

Have more questions? Submit a request

Comments