CROWDMANAGERCROWDMANAGER

Activities

Description

An activity resource represents a source of an event that a participant had created while interacting with a 3rd party system. This endpoint allows customers to export data from other systems and then to import it in CROWDMANAGER systems to be further processes and unified.

It requires support for handling vendor specific activity's CustomData, Type, Subtype. In this case, please contact technical-support@crowdmanager.io for more information.

Fields

Name Description Type/Supported Values Supported Methods
ExternalId Represents the id of the activity in your system. string POST
Type Generic type for the imported activity. The supported values needs to be established after contacting technical-support. string POST
Subtype Generic subtype for the imported activity. The supported values needs to be established after contacting technical-support. string POST
CreatedDateTime Time of creation. Can be null/empty datetime POST
IdentityId The id of the participant in Crowdmanager. If no Identity matches the provided ID, it will return a conflict error (409). long POST
CustomData Non required JSON which can contain more details regarding the generic activity. JSON POST

Publish an activity

Endpoint

POST https://api.crowdmanager.io/v2/{orgId}/mypage/activities

Warning

  1. The endpoint uses application/json content type instead of application/vnd.api+json used by most other endpoints in the API. The Accept header is entirely optional.
  2. The supported values for Activity Type and Subtype are not yet defined, please contact technical-support@crowdmanager.io

Example

Request

POST https://api.crowdmanager.io/v2/{orgId}/mypage/activities
Authorization: Basic aaabbbccc111222333
Content-Type: application/json

{
  "externalId": "123",
  "type": "...*",
  "subType": "...*",
  "createdDateTime": "2023-01-01T09:00:00",
  "identityId": 123456,
  "customData": {...} // custom json
}

Response

201 Created
{
    "id": "ExternalActivity-444-123",
    "type": "...*",
    "subType": "...*",
    "creationDateTime": "2023-01-22T09:00:00Z",   
    "customData":{...}, // same as in the request body    
    "identityId": 123456   
}

Errors

Code Error Message
409 "Could not find matching Identity with id: <1234>"
409 "Could not find matching Type/Subtype: <Type/SubType>"
409 "Activity with Id: <ExternalActivity-444-activityId> already belongs to other identity. DTO: <[the_request_body]>"