Activities / Types
Create Activity Type
This endpoint allows you to create an Activity Type based on JSON input.
You will only be able to create an Activity Type 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 |
REQUEST BODY
| Attribute | Type | Description |
|---|---|---|
| branchVisibility | Array | In which Branches the Activity Type is visible |
| descriptionBR | String | Activity Type name in Brasilian Portuguese |
| descriptionDE | String | Activity Type name in German |
| descriptionDK | String | Activity Type name in Dutch |
| descriptionEN (Required) | String | Activity Type name in English |
| descriptionES | String | Activity Type name in Spanish |
| descriptionFR | String | Activity Type name in French |
| descriptionIT | String | Activity Type name in Italian |
| descriptionPT | String | Activity Type name in Portuguese |
| descriptionRU | String | Activity Type name in Russian |
| descriptionUS | String | Activity Type name in American English |
| general | Boolean | If true, this Activity Type will appear when adding a normal Activity |
| checkin | Boolean | If true, this Activity Type will appear when doing a check-in |
| fastCheckin | Boolean | If true, this Activity Type will appear when doing a fast check-in |
| phoneCall | Boolean | If true, the Activity Type is a phone call |
| visit | Boolean | If true, the Activity Type is a visit |
| videoCall | Boolean | If true, the Activity Type is a video call |
| visibleInActivities | Boolean | If true, the Activity Type is visible in the activity feed |
| visibleInAgendaActivities | Boolean | If true, the Activity Type is visible in the calendar |
| workflow | Boolean | If true, the Activity Type is visible in workflows |
| order | Integer | The position in what you want the Activity Type to appear in the list |
RESPONSE
Returns a JSON with information about the Activity Type just created.
| Attribute | Type |
|---|---|
| Id | Id assigned to the new Activity Type |
| Message | The operation status |
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 |
post/activityTypes
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/activityTypes
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Request body
Response
Create Activity Type
Changes
No recorded changes to this operation across all 1 revision of this API.