API Reference

Add a user to a program with an optional arrival date

post
https://{customerDomain}.heyteam.com/eapi/users//programs

This endpoint is used to create a Program to a user using the program template defined as parameter.
An optional arrival date will be used prior

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

User id

Body Params
integer
required

Program template identifier (see /eapi/configuration/programs)

date

the starting date of the program. It will be use in priority even if an arrival_date was sent when creating the user. If no arrival date was sent during the user on creation, it becomes mandatory for this request.

key_dates
array of objects

List of additional key dates

key_dates
repositories
object

Custom entities/repositories to associate with the user program. Key is the entity slug, value is the repository key. These will override default entities for the same repository type. Only custom repositories can be updated via this parameter.

Responses

Updated 23 days ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 23 days ago