Skip to main content

Delete A Portfolio employer

Deletes an existing employer permanently. This action cannot be undone.

HTTP Request

DELETE/api/portfolios/employers/:id

Authorization

Authorization

  • Required: Yes
  • Permission: Staff with PorfolioEmployerPermission or Admin
  • Permission Code: 4224
  • Authentication: Token-based (Authorization: Token <your_api_key>)

Path Parameters

ParameterTypeRequiredDescription
idIntegerYesUnique ID of the employer to delete

Example Requests

1import requests
2
3# Delete a employer
4response = requests.delete('http://www.example.com/api/portfolios/employers/123', 
5  headers={'Authorization': 'Token <your_api_key>'}
6)
7print(response.status_code)  # Should be 204 for successful deletion
8
9# Check if deletion was successful
10if response.status_code == 204:
11  print("employer deleted successfully")
12else:
13  print(f"Deletion failed with status code: {response.status_code}")

Response Fields

FieldTypeDescription
NoneNoneNo response body returned for successful deletion