PUT api/v1/Commitments/{id}

Updates an existing commitment

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The ID of the commitment to be updated	globally unique identifier	Required
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 new values for the commitment

UpdateCommitment

Name	Description	Type	Additional information
Text	The new text for the commitment, leave empty or null to leave unchanged	string	None.
GoalID	The new Goal for the commitment, pass up null to leave unchanged	globally unique identifier	None.
Complete	The completed status of the commitment, pass up null to leave unchanged	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "Text": "sample string 1",
  "GoalID": "10dc9559-f2cb-4841-a52d-82df32c2166c",
  "Complete": true
}

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": "d8f9af29-f554-4868-8783-63c76f674795",
  "Text": "sample string 2",
  "Completed": true,
  "PeriodStartDate": "2024-05-19T09:02:19.7858609-04:00",
  "GoalID": "d8528ccd-c6ae-4be9-bde1-c93c1e77e518",
  "TeamID": "c0c200aa-e507-4bae-bdc7-a7b3b1fd0084",
  "UserID": "2e63ae60-807c-4fd1-8ad2-b83da8cebdf2"
}