Update requirement category status

Update the status of a user's requirement category instance for a given requirement category template.

Important: The {id} parameter is the requirement category template ID.

The request body identifies which user and program instance to update:

  • company_user_id: The user who owns the requirement category instance
  • company_user_program_id: The user program ID for that user
  • status: The new status to set

Special behavior: When transitioning from done to pending_user, the endpoint automatically:

  • Resets all related tasks to pending status
  • Clears task completion date
  • Clears validator ID

This allows the requirement to be unlocked in the Heyteam UI so the manager can correct the information.

How to get required IDs:

  • Template ID ({id}): Use GET /eapi/configuration/requirements/categories - each item has an id field
  • User ID: Use GET /eapi/users or GET /eapi/users/{id} - the id field is company_user_id
  • Program ID: Use GET /eapi/programs - each item has id and user_id
Language
Credentials
URL
Response
Click Try It! to start a request and see the response here!