Close a specific program for a user

post

https://{customerDomain}.heyteam.com/eapi/users/{id}/programs/{program}/close

Close a specific program for a user without triggering notifications of offboarding.

Important: The program parameter must be a user program ID (the ID of a program instance assigned to a specific user), not a program template ID.

To find the user program ID:

Use the GET /eapi/programs endpoint to list all user programs and find the id field
Or use GET /eapi/programs/{id} to get details of a specific user program

Idempotent: Closing an already closed program returns success.

Language

Credentials

URL

Response

Click Try It! to start a request and see the response here!