Skip to main content
DELETE
/
workspaces
/
{id}
/
clients
Remove Client
curl --request DELETE \
  --url https://api.kakiyo.com/v1/workspaces/{id}/clients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]"
}
'
{
  "message": "Client removed from workspace",
  "email": "[email protected]"
}
Agency Plan Required - This endpoint is only available for teams on the Agency plan.

​
Endpoint

DELETE https://api.kakiyo.com/v1/workspaces/:workspaceId/clients

​
Path Parameters

ParameterTypeRequiredDescription
workspaceIdstringYesThe workspace ID

​
Request Body

FieldTypeRequiredDescription
emailstringYesEmail address of the client to remove

​
Response

{
  "message": "Client removed from workspace",
  "email": "[email protected]"
}

​
Example Request

curl -X DELETE "https://api.kakiyo.com/v1/workspaces/69724d900007cfde1d88/clients" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email": "[email protected]"}'

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Workspace ID

Body

application/json
​
email
string<email>
required

Email address of the client to remove

Example:

"[email protected]"

Response

Client removed successfully

​
message
string
Example:

"Client removed from workspace"

​
email
string