HTTP Methods
Http Verb | Description | Example |
---|---|---|
GET | Retrieves a resource. | The GET /object/field endpoint in the fields resource retrieves a list of all fields. |
POST | Creates a new resource in a collection. | The POST /creation/creation endpoint in the objects resource creates a new object. |
PUT | Updates an existing resource. | The PUT /object/emailTemplate/{id} endpoint in the emailTemplate resource updates one or more elements in an email template. |
DELETE | Deletes a resource. | The DELETE /data/file/{id} endpoint in the file resource deletes a file. |
Response Codes
Response Code | Description |
---|---|
200 OK | The request was successful. For the GET method, details of the resource are returned in the Response Body. For PUT, POST, or DELETE a description of the action is returned in the Response Body. |
204 No Content | The request was successful, but no content is returned in the Response Body. |
400 Bad Request | The server couldn't understand the request due to an invalid parameter or syntax. |
401 Unauthorized | The client is not authenticated and the response was not completed. |
403 Forbidden | The client doesn't have permission to access the content. |
404 Not Found | The server couldn't find the requested resource. |
422 Unprocessable Entity (WebDAV) | The request was well-formed, but the server was unable to process the request due to syntax errors. |
500 Internal Server Error | An internal error occurred. |
503 Service Unavailable | The server can't currently handle the request. |