News
List News
Returns all News available. News are basically messages that you can sent to the whole organization, to your team or to an User. These messages can be tracked in terms of the number of Users that had received, open or read it.
You will only receive the News after first providing the Session Key. To know how you can obtain the Session Key, go to Authentication.
HEADERS
| Parameter | Value | Description |
|---|---|---|
| Content-Type | application/json | Language in which all request and response bodies are encoded |
| Accept | */* | Any data of whatever mime type is accepted |
| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |
| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |
RESPONSE
This endpoint returns all News available for the value list.
List of the supported News attributes:
| Attribute | Type | Description |
|---|---|---|
| dateCreated | String | Date and time when the News was created |
| dateDeleted | String | Date and time when the News was deleted |
| dateUpdated | String | Date and time when the News was last updated |
| deleted | Boolean | If true, the News has been deleted and archived |
| descriptionText | String | The content of the News to be communicated |
| id | Integer | Unique identifier for the News in ForceManager |
| idIanaZone | String | Identifier of the News in the IANA database |
| salesRepIdCreated | Integer | Unique identifier of the user who created the News |
| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the News |
| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the News |
| startDate | Date | When the News is sent |
| endDate | Date | When the News is going to expire |
| status | Integer | The status of the News (1 for Confirmed,2 for Opened,3 for Received,4 for Sent) |
| subject | String | The title of the News |
| totalUsers | Integer | The number of Users to whom the News is addressed |
RESPONSE CODES
| Status | Description |
|---|---|
| 200 OK | Shows if operation succeeded |
| 400 Bad Request | Shows when an invalid request or the requested service is not available |
get/news
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/news
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Response
List News
Changes
No recorded changes to this operation across all 1 revision of this API.