Skip to main content
DELETE
/
api
/
v1
/
profiles
/
{name}
Delete Profile
curl --request DELETE \
  --url https://agentgate.mynewapi.com/api/v1/profiles/{name} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "name": "<string>",
    "message": "<string>"
  }
}

​
Delete Profile

Deletes a custom profile. Built-in profiles cannot be deleted.
This endpoint requires authentication. Profiles with dependents cannot be deleted.

​
Request

​
name
string
required
The profile name to delete
curl -X DELETE https://agentgate.mynewapi.com/api/v1/profiles/my-custom-profile \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Response

​
success
boolean
required
Indicates if the request was successful
​
data
object
required
Delete result

​
Example Response

{
  "success": true,
  "data": {
    "name": "my-custom-profile",
    "message": "Profile deleted successfully"
  },
  "requestId": "req_abc123"
}

​
Error Responses

​
Cannot Delete Built-in Profile

{
  "success": false,
  "error": {
    "code": "FORBIDDEN",
    "message": "Cannot delete built-in profile: default"
  }
}

​
Profile Has Dependents

{
  "success": false,
  "error": {
    "code": "CONFLICT",
    "message": "Cannot delete profile: other profiles depend on it",
    "details": {
      "dependents": ["child-profile-1", "child-profile-2"]
    }
  }
}

​
Profile Not Found

{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Profile not found: unknown-profile"
  }
}