Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The API encourages the proper use of GET, POST, PUT, and DELETE when interacting with the API. For all POST and PUT requests , the API will pass only post parameters to the requested resource. For PUT only put parameters will be passed. Similarly, for all GET and DELETE requests, the API will pass only get parameters to the requested resource.

POST

Use POST requests when creating new records. For example, when adding a new user record via api/users/add.json.

GET

Use GET requests when retrieving record data. For example, when fetching a user record via api/users/get.json.

PUT

Use PUT requests when updating records. For example, when updating a user record via api/users/edit.json.

DELETE

Use DELETE requests when deleting records. For example, when deleting a user record via api/users/delete.json.

Requests

The API supports hundreds of requests, and many more through API extensions, so we can't document them all here. Instead, check out the source code documentation.