Remove several athletes from the agent's client list

curl --request DELETE \
  --url http://localhost/mogl/mogl-backend/api/agent/athletes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "athlete_ids": [
    28550,
    28551
  ],
  "is_all_selected": true,
  "filter": {},
  "excluded_athlete_id": [
    28552
  ]
}
'

import requests

url = "http://localhost/mogl/mogl-backend/api/agent/athletes"

payload = {
    "athlete_ids": [28550, 28551],
    "is_all_selected": True,
    "filter": {},
    "excluded_athlete_id": [28552]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'DELETE',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    athlete_ids: [28550, 28551],
    is_all_selected: true,
    filter: {},
    excluded_athlete_id: [28552]
  })
};

fetch('http://localhost/mogl/mogl-backend/api/agent/athletes', 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 => "http://localhost/mogl/mogl-backend/api/agent/athletes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => json_encode([
    'athlete_ids' => [
        28550,
        28551
    ],
    'is_all_selected' => true,
    'filter' => [
        
    ],
    'excluded_athlete_id' => [
        28552
    ]
  ]),
  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 := "http://localhost/mogl/mogl-backend/api/agent/athletes"

	payload := strings.NewReader("{\n  \"athlete_ids\": [\n    28550,\n    28551\n  ],\n  \"is_all_selected\": true,\n  \"filter\": {},\n  \"excluded_athlete_id\": [\n    28552\n  ]\n}")

	req, _ := http.NewRequest("DELETE", 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.delete("http://localhost/mogl/mogl-backend/api/agent/athletes")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"athlete_ids\": [\n    28550,\n    28551\n  ],\n  \"is_all_selected\": true,\n  \"filter\": {},\n  \"excluded_athlete_id\": [\n    28552\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost/mogl/mogl-backend/api/agent/athletes")

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

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"athlete_ids\": [\n    28550,\n    28551\n  ],\n  \"is_all_selected\": true,\n  \"filter\": {},\n  \"excluded_athlete_id\": [\n    28552\n  ]\n}"

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

{
  "message": "Clients removed.",
  "data": {
    "athlete_ids": [
      28550,
      28551
    ]
  }
}

{
  "message": "You can only manage athletes you represent.",
  "error_code": "ATHLETE_NOT_LINKED",
  "errors": {
    "athlete_ids": [
      28551
    ]
  }
}

Remove several athletes from the agent's client list

Backs the Remove Clients modal, where athletes are selected with checkboxes and confirmed together (ENG-1465). *

All-or-nothing: every selected athlete is verified before anything is removed, so a selection containing an athlete the agent does not represent removes nobody and returns ATHLETE_NOT_LINKED listing the rejected ids. That keeps the modal able to say exactly what happened.
Each athlete is then removed through the same path as DELETE /agent/athletes/, so notifications, payout-bypass recalculation and the Segment event stay per athlete. Historical payout records are untouched: an agent keeps their pay history for deals they managed.
Two ways to say what to remove. List the ids in athlete_ids, or send is_all_selected for Select All and let the server resolve them. Select All means every row the current filter matches, not the current page, so send the same filter the roster list was showing — without it, Select All means the whole roster. Rows the agent then unchecked go in excluded_athlete_id. The convention matches the partner bulk-hire and content-folder endpoints.

DELETE

agent

athletes

Remove several athletes from the agent's client list

curl --request DELETE \
  --url http://localhost/mogl/mogl-backend/api/agent/athletes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "athlete_ids": [
    28550,
    28551
  ],
  "is_all_selected": true,
  "filter": {},
  "excluded_athlete_id": [
    28552
  ]
}
'

import requests

url = "http://localhost/mogl/mogl-backend/api/agent/athletes"

payload = {
    "athlete_ids": [28550, 28551],
    "is_all_selected": True,
    "filter": {},
    "excluded_athlete_id": [28552]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'DELETE',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    athlete_ids: [28550, 28551],
    is_all_selected: true,
    filter: {},
    excluded_athlete_id: [28552]
  })
};

fetch('http://localhost/mogl/mogl-backend/api/agent/athletes', 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 => "http://localhost/mogl/mogl-backend/api/agent/athletes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => json_encode([
    'athlete_ids' => [
        28550,
        28551
    ],
    'is_all_selected' => true,
    'filter' => [
        
    ],
    'excluded_athlete_id' => [
        28552
    ]
  ]),
  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 := "http://localhost/mogl/mogl-backend/api/agent/athletes"

	payload := strings.NewReader("{\n  \"athlete_ids\": [\n    28550,\n    28551\n  ],\n  \"is_all_selected\": true,\n  \"filter\": {},\n  \"excluded_athlete_id\": [\n    28552\n  ]\n}")

	req, _ := http.NewRequest("DELETE", 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.delete("http://localhost/mogl/mogl-backend/api/agent/athletes")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"athlete_ids\": [\n    28550,\n    28551\n  ],\n  \"is_all_selected\": true,\n  \"filter\": {},\n  \"excluded_athlete_id\": [\n    28552\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost/mogl/mogl-backend/api/agent/athletes")

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

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"athlete_ids\": [\n    28550,\n    28551\n  ],\n  \"is_all_selected\": true,\n  \"filter\": {},\n  \"excluded_athlete_id\": [\n    28552\n  ]\n}"

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

{
  "message": "Clients removed.",
  "data": {
    "athlete_ids": [
      28550,
      28551
    ]
  }
}

{
  "message": "You can only manage athletes you represent.",
  "error_code": "ATHLETE_NOT_LINKED",
  "errors": {
    "athlete_ids": [
      28551
    ]
  }
}

Authorizations

Authorization

string

header

required

JWT Bearer token authentication. Use the /api/login endpoint to obtain a token.

Body

application/json

athlete_ids

integer[]

Athlete user ids. Required unless is_all_selected is set. All must be on the authenticated agent's roster.

Minimum array length: 1

Example:

[28550, 28551]

is_all_selected

boolean

Select All. The server resolves the ids from the filtered roster, so the client does not have to page through it first. The boolean, the strings true and 1, and the number 1 are all accepted.

Example:

true

filter

object

Only read with is_all_selected, and then it defines what all means. Same shapes GET /agent/athletes documents.

excluded_athlete_id

integer[]

Only read with is_all_selected. Rows the agent unchecked after selecting all.

Example:

[28552]

Response

Representations ended

message

string

Example:

"Clients removed."

data

object

Show child attributes

Core API

University API

Notifications API

Remove several athletes from the agent's client list

Authorizations

Body

Response