Delete a coach note from a coaching period
DELETE/api/public/escorts/{escortId}/notes/{noteId}
Delete a coach note from a coaching period.
Authentication
Requires an API key, sent as Authorization: Bearer cp_live_....
API keys carry scopes. Get the catalog of scopes and webhook events lists every scope.
Path parameters
| Name | Type | Description |
|---|---|---|
escortIdrequired | string | |
noteIdrequired | string |
Header parameters
| Name | Type | Description |
|---|---|---|
Idempotency-Key | string | Optional. Send a unique key (e.g. a UUID) to make this POST safe to retry. The same key within 24h returns the original result instead of creating a duplicate. |
Request examples
curl --request DELETE \
--url 'https://api.coach-platform.com/api/public/escorts/<escortId>/notes/<noteId>' \
--header 'Authorization: Bearer cp_live_...'const response = await fetch('https://api.coach-platform.com/api/public/escorts/<escortId>/notes/<noteId>', {
method: 'DELETE',
headers: {
Authorization: 'Bearer cp_live_...',
},
});
const data = await response.json();Responses
200 OK
Successful response
{
"data": {
"id": "<string>",
"deleted": true
}
}Response fields (3)
| Name | Type | Description |
|---|---|---|
data | object | |
data.id | string | |
data.deleted | boolean |
Error responses
400Bad Request401Unauthorized403Forbidden404Not Found409Conflict429Too Many Requests500Internal Server Error
These statuses share the same response body.
{
"error": {
"code": "<string>",
"message": "<string>",
"fix": "<string>",
"details": {},
"retryAfterMs": 123
}
}Error fields (6)
| Name | Type | Description |
|---|---|---|
error | object | |
error.code | string | |
error.message | string | |
error.fix | string | null | |
error.details | object | null | |
error.retryAfterMs | number | null |
More Escorts endpoints
This page is also available as Markdown. Browse it in the interactive explorer or download the OpenAPI spec.