Web Service Methods Actions

API → Actions

add_goal_by_id

This method requires authentication. It will attempt to add the given goal id to the authenticated user’s list of 43 things, and return the goal itself upon success or an error message upon failure.

Arguments:
  • api_key (required)
  • id (required)
An Example Response: 


	
Demo: Not available







	
add_goal_by_name



	
This method requires authentication.  It will attempt to add the goal with the given name to the authenticated user’s list of 43 things, and return the goal itself upon success or an error message upon failure.



Arguments:
	
    
	
  • api_key (required)
    • 
		
  • name (required)
    • 
	



An Example Response:



	
Demo: Not available







	
complete_goal



	
This method requires authentication.  It will attempt to mark the goal with the given id as complete assuming that it is on their list and not yet marked as complete.  On success, it will return the full progress for that particular goal (see get_persons_progress_on_goal).  Otherwise, it will return an error message.



Arguments:
	
    
	
  • api_key (required)
    • 
		
  • id (required)
    • 
	



An Example Response:



	
Demo: Not available







	
remove_goal



	
This method requires authentication.  It will attempt to remove the goal with the given id from the authenticated person’s list.  On success, it will return the Goal that has been removed.  Otherwise, it will return an error message.



Arguments:
	
    
	
  • api_key (required)
    • 
		
  • id (required)
    • 
	



An Example Response:



	
Demo: Not available







	
update_goal



	
This method requires authentication.  If the goal is not yet completed, it will allow you to update the goal’s name.  If the goal is marked as complete, it will allow you to update the flag for whether or not you thought the goal was worth doing, and whether or not you’re willing to help others complete this goal.



Arguments:
	
    
	
  • api_key (required)
    • 
		
  • id (required)
    • 
		
  • name (optional, will change goal’s name to that supplied)
    • 
		
  • worth_it (optional, must be “0” or “1” if supplied)
    • 
		
  • help_others (optional, must be “0” or “1” if supplied)
    • 
	



An Example Response:



	
Demo: Not available