API entity save

From FreeDESK
(Difference between revisions)
Jump to: navigation, search
(Created page with "{{Infobox API | name = Entity Save | mode = entity_save | description = Save an entity record | parameters = entity, [fields] | returned = XML success or error }} This article...")
 

Latest revision as of 21:31, 21 August 2012

Entity Save
Call/Mode: entity_save
Description: Save an entity record
Parameters: entity, [fields]
Returned Data: XML success or error

This article details a FreeDESK API call.

[edit] Description

This call will update a stored entity record

[edit] Using the Call

Pass in the following parameters using GET or POST

  • entity : Entity name
  • [fields] : Field list in the format fieldname=value

For example

api.php?mode=entity_save&entity=customer&customerid=1&firstname=David

Please note that you 'must' pass the keyfield for the entity unmodified for the record to be successfully updated.

[edit] Returned Data

XML containing either a XML Operation Confirmation or a FreeDESK error on failure.

Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox