Methods
How you act on resources.
What are methods?
Methods tell us, in general, what you want to do with a resource.
Our API uses standard HTTP methods, such as GET, POST, and DELETE.
What methods can I use?
All the specific methods you can use with our endpoints can be found in our API explorer.
In general, here are the different methods we support:
| Method | Description |
|---|---|
| GET | Get information about a resource without affecting it. Examples: Get information about a customer Download a PDF of a quote |
| PATCH | Update part of a resource. Examples: Change a contact's name Change the status of an order |
| POST | Take action on a resource. Examples: Run a report Create a request |
| PUT | Replace a resource. Examples: * Change who a task is assigned to (by replacing it with a task that's identical except for the "assigned to" field) |
| DELETE | Delete a resource. Examples: * Delete a contact |
More information
- "HTTP Methods: GET vs. POST" by W3Schools
Updated about 6 years ago
What’s Next
Methods tell us the basics of how you want to work with a resource, but parameters give us the details.
