The GoFormz API strives to follow REST best practices while still being pragmatic. Below is a list of the HTTP Methods supported by the API and when to use them.

Method

Description

GET

Retrieves both a single resource if an ID is provided, or a list of resources.

POST

Creates a new resource.

PATCH

PATCH is used in order to provide partial updates to an existing resource. When patching a resource, partial JSON should be provided in the body of the request.

PUT

PUT is used for replacing an existing resource, this operation is not supported on all endpoints. In most cases you will want to use PATCH as it is more common to provide partial updates to an existing resource.

DELETE

Deletes a resource.