Onboard a user as athlete, coach or parent

curl --request POST \
  --url https://www.fundor.io/api/v1/users/{id}/onboarding \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "role": "athlete",
  "teamCode": "ABC123"
}
'

import requests

url = "https://www.fundor.io/api/v1/users/{id}/onboarding"

payload = {
    "role": "athlete",
    "teamCode": "ABC123"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({role: 'athlete', teamCode: 'ABC123'})
};

fetch('https://www.fundor.io/api/v1/users/{id}/onboarding', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.fundor.io/api/v1/users/{id}/onboarding",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'role' => 'athlete',
    'teamCode' => 'ABC123'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.fundor.io/api/v1/users/{id}/onboarding"

	payload := strings.NewReader("{\n  \"role\": \"athlete\",\n  \"teamCode\": \"ABC123\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://www.fundor.io/api/v1/users/{id}/onboarding")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"role\": \"athlete\",\n  \"teamCode\": \"ABC123\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.fundor.io/api/v1/users/{id}/onboarding")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"role\": \"athlete\",\n  \"teamCode\": \"ABC123\"\n}"

response = http.request(request)
puts response.read_body

{
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "role": "<string>",
  "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "teamMemberId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "teamCode": "<string>",
  "coachCode": "<string>",
  "referralLink": {
    "url": "<string>",
    "qrCodeSvg": "<string>",
    "qrCodeDataUrl": "<string>"
  }
}

{
  "error": {
    "code": "consent_required",
    "message": "consent.ip is required. Fundor will reject the lead without it.",
    "field": "consent.ip"
  }
}

{
  "error": {
    "code": "consent_required",
    "message": "consent.ip is required. Fundor will reject the lead without it.",
    "field": "consent.ip"
  }
}

{
  "error": {
    "code": "consent_required",
    "message": "consent.ip is required. Fundor will reject the lead without it.",
    "field": "consent.ip"
  }
}

{
  "error": {
    "code": "consent_required",
    "message": "consent.ip is required. Fundor will reject the lead without it.",
    "field": "consent.ip"
  }
}

{
  "error": {
    "code": "consent_required",
    "message": "consent.ip is required. Fundor will reject the lead without it.",
    "field": "consent.ip"
  }
}

{
  "error": {
    "code": "consent_required",
    "message": "consent.ip is required. Fundor will reject the lead without it.",
    "field": "consent.ip"
  }
}

Users

Onboard a user as athlete, coach or parent

Athlete: role: athlete + teamCode. Returns the athlete’s teamMemberId and hosted referral link.
Coach, new team: role: coach + schoolName, teamName, sport (+ goals). Returns teamCode (share with athletes) and coachCode (share only with other coaches).
Coach, existing team: role: coach, coachMode: join, coachCode.
Parent: role: parent + parentCode, athleteId.

The user must be one you created or one whose owner approved your link. Requires the users scope.

POST

users

{id}

onboarding

Onboard a user as athlete, coach or parent

curl --request POST \
  --url https://www.fundor.io/api/v1/users/{id}/onboarding \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "role": "athlete",
  "teamCode": "ABC123"
}
'

import requests

url = "https://www.fundor.io/api/v1/users/{id}/onboarding"

payload = {
    "role": "athlete",
    "teamCode": "ABC123"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({role: 'athlete', teamCode: 'ABC123'})
};

fetch('https://www.fundor.io/api/v1/users/{id}/onboarding', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.fundor.io/api/v1/users/{id}/onboarding",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'role' => 'athlete',
    'teamCode' => 'ABC123'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.fundor.io/api/v1/users/{id}/onboarding"

	payload := strings.NewReader("{\n  \"role\": \"athlete\",\n  \"teamCode\": \"ABC123\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://www.fundor.io/api/v1/users/{id}/onboarding")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"role\": \"athlete\",\n  \"teamCode\": \"ABC123\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.fundor.io/api/v1/users/{id}/onboarding")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"role\": \"athlete\",\n  \"teamCode\": \"ABC123\"\n}"

response = http.request(request)
puts response.read_body

{
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "role": "<string>",
  "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "teamMemberId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "teamCode": "<string>",
  "coachCode": "<string>",
  "referralLink": {
    "url": "<string>",
    "qrCodeSvg": "<string>",
    "qrCodeDataUrl": "<string>"
  }
}

{
  "error": {
    "code": "consent_required",
    "message": "consent.ip is required. Fundor will reject the lead without it.",
    "field": "consent.ip"
  }
}

{
  "error": {
    "code": "consent_required",
    "message": "consent.ip is required. Fundor will reject the lead without it.",
    "field": "consent.ip"
  }
}

{
  "error": {
    "code": "consent_required",
    "message": "consent.ip is required. Fundor will reject the lead without it.",
    "field": "consent.ip"
  }
}

{
  "error": {
    "code": "consent_required",
    "message": "consent.ip is required. Fundor will reject the lead without it.",
    "field": "consent.ip"
  }
}

{
  "error": {
    "code": "consent_required",
    "message": "consent.ip is required. Fundor will reject the lead without it.",
    "field": "consent.ip"
  }
}

{
  "error": {
    "code": "consent_required",
    "message": "consent.ip is required. Fundor will reject the lead without it.",
    "field": "consent.ip"
  }
}

Authorizations

Authorization

string

header

required

Your partner API key, sent as Authorization: Bearer fnd_live_…. Keys are issued by Fundor on request. Keep them on your server; never ship one in a mobile or browser app.

Path Parameters

string<uuid>

required

userId from POST /users.

Body

application/json

role

enum<string>

required

Available options:

athlete,

coach,

parent

teamCode

string

coachMode

enum<string>

default:create

Available options:

create,

join

coachCode

string

schoolName

string

schoolCity

string

schoolState

string

teamName

string

sport

string

teamGoal

number

individualGoal

number

seasonStart

string<date>

targetAmount

number

parentCode

string

athleteId

string<uuid>

Response

Onboarded.

userId

string<uuid>

role

string

teamId

string<uuid>

teamMemberId

string<uuid>

teamCode

string

coachCode

string

referralLink

object

Show child attributes

Consent & services

Users

Teams

Leads

Applications

Consent & services

Users

Teams

Leads

Applications

Onboard a user as athlete, coach or parent

Authorizations

Path Parameters

Body

Response