POST api/Challenge/CreateChallenge

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	integer	None.
ChallengeName	string	None.
Description	string	None.
PrimaryActivityName	string	None.
PrimaryMetricId	integer	None.
PrimaryMetricGoal	decimal number	None.
SecondaryActivityName	string	None.
SecondaryMetricId	integer	None.
SecondaryMetricGoal	decimal number	None.
StartDate	date	None.
EndDate	date	None.
DurationInDays	integer	None.
ChallengeTypeId	integer	None.
ChallengeTypeName	string	None.
CreatedByUserId	integer	None.
CreatedDate	date	None.
UpdatedByUserId	integer	None.
UpdatedDate	date	None.
Category	string	None.
IsCompleted	boolean	None.
PrimaryMetricUnits	string	None.
SecondaryMetricUnits	string	None.
ChallengeTemplateId	integer	None.
TemplateName	string	None.
ChallengeDataId	integer	None.
UserId	integer	None.
UserName	string	None.
StatusId	integer	None.
StatusName	string	None.
PrimaryMetricValue	decimal number	None.
SecondaryMetricValue	decimal number	None.
Rank	integer	None.
GoalReached	boolean	None.
CompletionPercent	decimal number	None.
ChallengeTypes	Collection of ChallengeTypeModel	None.
ChallengeTemplates	Collection of ChallengeTemplatesModel	None.
MeasurementDefinitions	Collection of MeasurementDefinitionModel	None.
ChallengeDatas	Collection of ChallengeDataModel	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "ChallengeName": "sample string 2",
  "Description": "sample string 3",
  "PrimaryActivityName": "sample string 4",
  "PrimaryMetricId": 5,
  "PrimaryMetricGoal": 6.1,
  "SecondaryActivityName": "sample string 7",
  "SecondaryMetricId": 8,
  "SecondaryMetricGoal": 9.1,
  "StartDate": "2026-09-08T21:10:54.5603222+00:00",
  "EndDate": "2026-09-08T21:10:54.5603222+00:00",
  "DurationInDays": 10,
  "ChallengeTypeId": 11,
  "ChallengeTypeName": "sample string 12",
  "CreatedByUserId": 13,
  "CreatedDate": "2026-09-08T21:10:54.5603222+00:00",
  "UpdatedByUserId": 15,
  "UpdatedDate": "2026-09-08T21:10:54.5603222+00:00",
  "Category": "sample string 17",
  "IsCompleted": true,
  "PrimaryMetricUnits": "sample string 19",
  "SecondaryMetricUnits": "sample string 20",
  "ChallengeTemplateId": 21,
  "TemplateName": "sample string 22",
  "ChallengeDataId": 23,
  "UserId": 24,
  "UserName": "sample string 25",
  "StatusId": 26,
  "StatusName": "sample string 27",
  "PrimaryMetricValue": 28.1,
  "SecondaryMetricValue": 29.1,
  "Rank": 30,
  "GoalReached": true,
  "CompletionPercent": 32.0,
  "ChallengeTypes": [
    {
      "Type": "sample string 1",
      "Id": 2
    },
    {
      "Type": "sample string 1",
      "Id": 2
    }
  ],
  "ChallengeTemplates": [
    {
      "Id": 1,
      "TemplateName": "sample string 2",
      "PrimaryActivityName": "sample string 3",
      "PrimaryMetricId": 4,
      "PrimaryMetricGoal": 5.1,
      "SecondaryActivityName": "sample string 6",
      "SecondaryMetricId": 1,
      "SecondaryMetricGoal": 1.1,
      "ChallengeTypeId": 7,
      "ChallengeTypeName": "sample string 8",
      "CreatedByUserId": 9,
      "CreatedDate": "2026-09-08T21:10:54.5603222+00:00",
      "UpdatedByUserId": 11,
      "UpdatedDate": "2026-09-08T21:10:54.5603222+00:00"
    },
    {
      "Id": 1,
      "TemplateName": "sample string 2",
      "PrimaryActivityName": "sample string 3",
      "PrimaryMetricId": 4,
      "PrimaryMetricGoal": 5.1,
      "SecondaryActivityName": "sample string 6",
      "SecondaryMetricId": 1,
      "SecondaryMetricGoal": 1.1,
      "ChallengeTypeId": 7,
      "ChallengeTypeName": "sample string 8",
      "CreatedByUserId": 9,
      "CreatedDate": "2026-09-08T21:10:54.5603222+00:00",
      "UpdatedByUserId": 11,
      "UpdatedDate": "2026-09-08T21:10:54.5603222+00:00"
    }
  ],
  "MeasurementDefinitions": [
    {
      "Name": "sample string 1",
      "Id": 2,
      "DisplayOrder": 1,
      "Label": "sample string 3"
    },
    {
      "Name": "sample string 1",
      "Id": 2,
      "DisplayOrder": 1,
      "Label": "sample string 3"
    }
  ],
  "ChallengeDatas": [
    {
      "Id": 1,
      "ChallengeId": 2,
      "ChallengeName": "sample string 3",
      "UserId": 4,
      "UserName": "sample string 5",
      "StatusId": 6,
      "StatusName": "sample string 7",
      "PrimaryActivityName": "sample string 8",
      "PrimaryMetricId": 9,
      "PrimaryMetricValue": 10.1,
      "SecondaryActivityName": "sample string 11",
      "SecondaryMetricId": 12,
      "SecondaryMetricValue": 13.1,
      "Rank": 14,
      "GoalReached": true,
      "LastUpdatedByUserId": 16,
      "LastUpdatedDate": "2026-09-08T21:10:54.5803113+00:00",
      "CompletionPercent": 18.0
    },
    {
      "Id": 1,
      "ChallengeId": 2,
      "ChallengeName": "sample string 3",
      "UserId": 4,
      "UserName": "sample string 5",
      "StatusId": 6,
      "StatusName": "sample string 7",
      "PrimaryActivityName": "sample string 8",
      "PrimaryMetricId": 9,
      "PrimaryMetricValue": 10.1,
      "SecondaryActivityName": "sample string 11",
      "SecondaryMetricId": 12,
      "SecondaryMetricValue": 13.1,
      "Rank": 14,
      "GoalReached": true,
      "LastUpdatedByUserId": 16,
      "LastUpdatedDate": "2026-09-08T21:10:54.5803113+00:00",
      "CompletionPercent": 18.0
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.