Skip to content

Commit 403e077

Browse files
docs: add notes about correct content type usage
1 parent 37bd3e0 commit 403e077

2 files changed

Lines changed: 10 additions & 2 deletions

File tree

docs/COMMON_CONTROL_PARAMETERS.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
# Common Control Parameters
22

33
The API utilizes a set of common parameters to control certain behaviors of API calls. These parameters are available to
4-
all endpoints and requests, but some endpoints may not support all parameters. Below are the available control
5-
parameters you can use:
4+
all endpoints and requests, but some endpoints may not support all parameters.
5+
6+
!!! Note
7+
Requests must pass these parameters according to your specific [content type](CONTENT_AND_ACCEPT_TYPES.md). For
8+
example, if you are using the `application/json` content-type, these parameters should be included in the JSON body
9+
of your request. Content types cannot be mixed.
610

711
## append
812

docs/CONTENT_AND_ACCEPT_TYPES.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ The REST API has been designed to allow multiple content and accept types to be
66

77
Content types are used to specify the format of the data being sent in your request. You must specify the content type in the `Content-Type` header of your request. The REST API supports the following content types:
88

9+
!!! Important
10+
Only one content type can be specified per request. Data formats cannot be mixed. For example, a request cannot
11+
use both a JSON body and URL query string parameters to send data.
12+
913
### application/json
1014
- MIME Type: `application/json`
1115
- Description: Use this content type to send JSON data in the body of your request. The data should be formatted as a JSON object or array.

0 commit comments

Comments
 (0)