POST api/v1/Commitments

Creates a new commitment

Request Information

URI Parameters

Name	Description	Type	Additional information
fields	Use this to only return the data fields you're interested in. Field names not found are ignored and no error is thrown. If no fields are found then the full object is returned.	Collection of string	None.
suppressResponseCodes	Some applications do wonky things if error codes are used. Use this to force 200s to always return.	boolean	None.
APIKey	This is your unique key that identifies you as the developer of this app. Required for all calls.	string	None.
APIToken	This is the user's session token generated when you authenticate the user	string	None.

Body Parameters

The values for the new commitment

NewCommitment

Name	Description	Type	Additional information
Text	The text body of the commitment	string	None.
PeriodStartDate	The week the commitment is for	date	None.
GoalID	The goal the commitment is tied to	globally unique identifier	None.
TeamID	The team this commitment is for	globally unique identifier	None.
UserID	The user responsible for this commitment	globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "Text": "sample string 1",
  "PeriodStartDate": "2024-11-21T01:21:31.916453-05:00",
  "GoalID": "1b8af097-2cec-47a8-a981-73a798151216",
  "TeamID": "9461e519-ccee-464f-9c5d-d2d9ac02bb85",
  "UserID": "15348c8e-dc7e-4b02-9c9b-dd208f63a161"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Commitment

Name	Description	Type	Additional information
ID	The commitment's ID	globally unique identifier	None.
Text	The text body of the commitment	string	None.
Completed	Whether the user has completed the commitment	boolean	None.
PeriodStartDate	The week the commitment is for	date	None.
GoalID	The goal the commitment is tied to	globally unique identifier	None.
TeamID	The team this commitment is a part of (a user can be on multiple teams)	globally unique identifier	None.
UserID	The user this commitment is assigned to	globally unique identifier	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": "557bb6bc-8885-4856-b7a3-cf5c20bf057c",
  "Text": "sample string 2",
  "Completed": true,
  "PeriodStartDate": "2024-11-21T01:21:31.9224988-05:00",
  "GoalID": "18e3a1ef-80c9-4e40-9cf6-13c1d6c9b31d",
  "TeamID": "841177ea-857d-4e69-8cf6-a4fc8b158e4c",
  "UserID": "3107032c-a99d-4063-99e4-91fd4bc5258e"
}