Skip to content
Recruso API

Delete a lead

DELETE
/v1/leads/{id}
curl --request DELETE \
  --url https://api2.recruso.co.uk/v1/leads/1 \
  --header 'Authorization: <Authorization>'

Permanently deletes one lead in your own agency, together with its client status records.

As with a client, this is not a soft delete and there is no restore. The row is removed, so the delete only succeeds for a lead nothing else references.

A lead that still has related records — sites, cost centres or bookings — cannot be deleted and returns 400.

A live client id returns 404; delete it through DeleteClient. So does a lead belonging to another agency, or under a branch the Recruso user behind your API app cannot access.

Access. Requires a client-credentials access token. Tokens issued through the interactive user login are rejected.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
integer format: int32

The id path parameter

Responses

Section titled “Responses”

204

Section titled “204”

No Content

400

Section titled “400”

Bad Request

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

401

Section titled “401”

Unauthorized

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

403

Section titled “403”

Forbidden

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Section titled “404”

Not Found

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}