Supported HTTP Methods

All API requests must be made over HTTPS. The most commonly used HTTP methods (or verbs) are GET, POST, PATCH, and DELETE. The building blocks of REST APIs, these methods define actions applied to REST resources using their URLs.

Note:

You can combine multiple operations into a single HTTP request to improve performance.

The following table lists the methods and their scope for singular and collection resources.

Method Works with a Singular Resource? Works with a Collection Resource?
GET

Yes. Gets a single resource.

Yes. Gets a subset, or all of the resources in the collection.

POST

No. For a custom method, you can use the POST method for a singular resource.

Yes. Creates a new resource in the collection.

PATCH

Yes. Updates a resource.

No.

DELETE

Yes. Deletes a resource.

No.