Quick Start
A quick start guide to the upcoach API
In this quick start guide, we will be using the upcoach API to create a new client and add it to a program.
Your API requests are authenticated using API tokens. Any request that doesn't include an API token will return an error.
Send an authenticated request to the client endpoint to create a new client, which we will be using in the next step.
POST https://api.upcoach.com/clients
Content-Type: application/json
Authorization: Bearer <your api token>
{
"name": "Ryan Reynolds",
"email": "[email protected]"
}
Once you have successfully added a client, grab the
id from the returned client resource object. We will be using it in the next step.Don't forget to replace the
<your api token> placeholder with your own API tokenYou can learn more about how to use the client endpoint to add a new client to the organization in the resources section.
With the new client added, we will use the new client
id in the following request to add it to a program.POST https://api.upcoach.com/programs/<program id>/members
Content-Type: application/json
Authorization: Bearer <your api token>
{
"user": "<client id>",
}
Don't forget to replace the
<program id> and <client id> placeholders with your program and client idsYou can learn more about how to use the client endpoint to add a new client to the organization in the resources section.
Last modified 1yr ago