Request methods/verbs

Request methods define what action to take on resource data.

For information about how to authenticate and use the APIs, see Create an authentication key.

Alida supports the following methods:

Method/Verb Description
GET This is a request for data. A request should only retrieve data and perform no other action.
POST Creates a new entity.
PUT Modifies an existing entity.

The PUT body must contain the entire entity in the request.

PATCH Modifies an existing entity, however, only the fields that are being modified should be sent to the resource.

The PATCH syntax follows RFC 6902.

Supported operations:
  • add
  • remove
  • replace
Note: These may vary depending on the particular resource.