Skip to main content
DELETE
Archive a contact

Authorizations

Authorization
string
header
required

Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.

Path Parameters

id
integer
required

1club contact id

Query Parameters

keepCancellationCharge
boolean

Archiving cancels the contact's future bookings. For a paid one the cancellation policy would keep money from, say what happens to it: false refunds it in full, true applies the policy. Without it such an archive is refused (409 CANCELLATION_CHARGE_DECISION_REQUIRED) and nothing changes. Unpaid bookings owe nothing either way unless it is true.

Response

The contact is archived and everything it held was released

A contact (customer) in the organization. Reference the id as contactId when creating a booking.

id
integer
uuid
string<uuid>

Stable unguessable identifier. Prefer this over id when storing a reference.

name
string
firstName
string
lastName
string | null
email
string | null
phone
string | null
type
string | null

Derived contact type (e.g. contact, member, lead). archived marks a retired contact — hidden from the list and from search, but still readable by id.

pipelineStageId
integer | null

The sales pipeline stage the contact is in, or null when they are not in the pipeline.

pipelineLostReason
enum<string> | null

Why the lead was lost, while they are in the Lost stage. Null outside it, or when no reason was given.

Available options:
price,
timing,
chose_competitor,
location,
no_response,
not_interested,
not_a_fit,
other
pipelineLostNote
string | null

The note given with the lost reason.

sourceId
integer | null

Where the contact came from.

assignedToId
integer | null

The staff member (organization user id) following the contact up.

createdAt
string<date-time>