Delete a prospect interaction

DELETE /api/members/prospects/{memberId}/interactions/{id}

Products: not restricted by product
Features: Prospecting (PROSPECTS)

Overview

Removes one prospect interaction — a recorded call, task or appointment — from a member. A prospect is not a separate kind of record: it is an ordinary member whose member status carries the prospect indicator (the status configuration documents it as 0:Not a prospect; 1:Member is Prospect), which is why this route sits under /api/members/ and is addressed by member id.

The delete is permanent. The interaction is removed outright; there is no soft-delete flag, no archived copy and nothing this API can return afterwards, so a second delete of the same id fails with 404 rather than succeeding silently. If you need the record kept for reporting, mark the interaction completed with Update a prospect interaction instead of deleting it.

The interaction is matched on the id and the owning member id together, so an id that exists under a different member behaves exactly like an id that does not exist at all: 404, with no indication that the interaction is real. That protects one member's interactions from being removed through another member's path, but it is not an authorisation check — unlike most member routes in this API, the endpoint does not compare the memberId in the path against the member in your token. Any caller authorised for this API can delete any interaction, provided it passes the correct owning memberId.

Endpoint

DELETE {base_url}/api/members/prospects/{memberId}/interactions/{id}

{base_url} is the environment URL issued to your integration. See Authenticating with Gladstone APIs.

Path parameters

Name	Type	Required	Description
`memberId`	integer (int32)	Yes	The member the interaction belongs to. Must be a positive integer — zero or a negative value is rejected with 400 before any lookup happens. It must be the member the interaction was created against; supplying a different member returns 404 and deletes nothing.
`id`	integer (int32)	Yes	The interaction to delete, as returned in the `id` field by Create a prospect interaction or Get a member's prospect interactions. It is not range-checked, so a zero or negative id simply returns 404.

Sample request

cURL

curl -X DELETE '{base_url}/api/members/prospects/{memberId}/interactions/{id}' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'X-Use-SSO: true'

Errors

Status	Meaning	When
`400`	Bad request	`memberId` is zero or negative: `A valid memberId is required.` The interaction `id` is not validated this way — a nonsensical id gives 404, not 400.
`404`	Not found	`Interaction {id} was not found for member {memberId}.` — returned when no interaction with that id exists, when it exists but belongs to a different member, and when it has already been deleted. The three cases are indistinguishable from the response.
`500`	Internal server error	An unexpected server-side failure during the delete. The body is empty, and you cannot tell from the response whether the interaction was removed, so re-read the member's interactions before retrying.

This page as markdown · All pages · llms.txt