You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A brief description of the purpose of this endpoint, such as what resources it interacts with, and what actions it performs.
Request
Headers
Header Name
Required
Description
Example Value
Content-Type
Yes
The content type of the request body. Typically application/json.
application/json
Authorization
No
The authorization token, if required for this endpoint.
Bearer [Access-Token]
Path Parameters (If Needed)
Parameter Name
Required
Description
Type
Example Value
[parameter]
Yes/No
Description of the parameter, and any constraints on its value.
String
example
Query Parameters (If Needed)
Parameter Name
Required
Description
Type
Example Value
[parameter]
Yes/No
Description of the parameter, and any constraints on its value.
String
example
Request Body (JSON)
{
"[field1]": {
"type": "[data-type]",
"description": "Description of the field, and any constraints on its value.",
"required": true/false,"example": "example value"
},
"[field2]": {
"type": "[data-type]",
"description": "Description of the field, and any constraints on its value.",
"required": true/false,"example": "example value"
}
}