Actions are basic tasks you can perform in our API, like creating a customer or running a report. They are essentially combinations of an endpoint, method, and set of available parameters. When you specify those three things in your API requests, you're telling us about the action you want to take.
Why "available parameters?"
One action always has the same set of parameters you can use. For example, when you're searching for customers, you can always specify an account number, bill profile ID, and status.
But you don't have to specify all of those each time you want to search for a customer. You could send us just an account number in one search, and just a status in another search.
For a full list of actions you can take through our API, visit our API Explorer! Here, we'll list some examples.
|Create a note||Notes||POST|| subject|
|Search products||Products||GET|| product_id|
|View a customer||Customers||GET||* id|
|Replace an order||Orders||PUT|| id|
|Delete a task||Tasks||DELETE||* id|
Our example actions above involve many different endpoints, methods, and parameters. But for many sets of actions, just one of these is different.
|View an address||Addresses||GET||* id|
|View a bill profile||BillProfiles||GET||* id|
|View a package||Packages||GET||* id|
|View a file||Files||GET||* id|
|Delete a file||Files||DELETE||* id|
|View a request||Requests||GET||* id|
|Search requests||Requests||GET|| request_id|
|Download request PDF||Requests||GET|| id|
Updated almost 5 years ago
Let's take a closer look at how you perform actions: through endpoints.