/contacts/{contact_id} Delete a specific contact
Deletes a contact. Only users with the delete_contacts permission can delete contacts. Repeat the same request with undo=true to restore the most recent deletion for that ID — the restore window depends on the account plan, from 1 day up to 60 days.
Path parameters
| Name | Type | Description |
|---|---|---|
contact_id req | string | Contact ID |
Query parameters
| Name | Type | Description |
|---|---|---|
undo | boolean <boolean> | Undo Contact deletion |
Responses
200 OK
statusintegerint32Response code
messagestringResponse message
timestampintegerunix-timestampResponse time
dataobjectlead_sourcesarray<object>array item fields →
idstringID of the lead source
textstringrequiredDescription of the lead source
countsintegerint32Number of contacts the (logged API) user owns, with the lead source
total_countintegerint32Number of contacts the entire team owns, with the lead source
action_stream_countintegerint32Number of contacts the (logged API) user has actions with, who also have the lead source
team_countsarray<object>Number of contacts, with the lead source (for each team member)
array item fields →
user_idstringbson-idID of the user
countsintegerint32Number of contacts the team member owns, with the lead source
statusesarray<object>array item fields →
statusobjectValues which help qualify where contacts are in the sales pipeline. The list of Statuses is already populated but it may be updated if needed, to better fit your organization.
object fields →
idstringbson-idID of the status
statusstringType of the status
enum: lead · prospect · customer · inactive · general · custom1 · custom2 · customX
textstringrequiredDisplay text of the status
descriptionstringLonger description of what the status is for
colorstringhex-colorrequiredThe color of the status (six character hex value)
enum: 666666 · 3399ff · cc0000 · f96600 · 000000 · ff00ff · 009900
countsintegerint32Number of contacts the (logged API) user owns, with the status
total_countintegerint32Number of contacts the entire team owns, with the status
action_stream_countintegerint32Number of contacts the (logged API) user has actions with, who also have the status
team_countsarray<object>Number of contacts, with the status (for each team member)
array item fields →
user_idstringbson-idID of the user
countsintegerint32Number of contacts the team member owns, with the status
tagsobjectobject fields →
tagsarray<object>array item fields →
namestringName of the tag
countsintegerint32Number of contacts the (logged API) user owns, with the tag
total_countintegerint32Number of contacts the entire team owns, with the tag
action_stream_countintegerint32Number of contacts the (logged API) user has actions with, who also have the tag
system_tagsarray<object>array item fields →
namestringName of the tag
countsintegerint32Number of contacts the (logged API) user owns, with the tag
total_countintegerint32Number of contacts the entire team owns, with the tag
action_stream_countintegerint32Number of contacts the (logged API) user has actions with, who also have the tag
contacts_countobjectCounters showing the number of contacts per letter. The `all` object represents the entire account, while the `users` array contains the same breakdown but per user.
object fields →
allarray<object>Counters for the entire account
array item fields →
1integerint32Contacts who's name begins with a non-alphabetic character
aintegerint32Contacts who's name begins with A
bintegerint32Contacts who's name begins with B
cintegerint32Contacts who's name begins with C
dintegerint32Contacts who's name begins with D
eintegerint32Contacts who's name begins with E
fintegerint32Contacts who's name begins with F
gintegerint32Contacts who's name begins with G
hintegerint32Contacts who's name begins with H
iintegerint32Contacts who's name begins with I
jintegerint32Contacts who's name begins with J
kintegerint32Contacts who's name begins with K
lintegerint32Contacts who's name begins with L
mintegerint32Contacts who's name begins with M
nintegerint32Contacts who's name begins with N
ointegerint32Contacts who's name begins with O
pintegerint32Contacts who's name begins with P
qintegerint32Contacts who's name begins with Q
rintegerint32Contacts who's name begins with R
sintegerint32Contacts who's name begins with S
tintegerint32Contacts who's name begins with T
uintegerint32Contacts who's name begins with U
vintegerint32Contacts who's name begins with V
wintegerint32Contacts who's name begins with W
xintegerint32Contacts who's name begins with X
yintegerint32Contacts who's name begins with Y
zintegerint32Contacts who's name begins with Z
total_countintegerint32
usersarray<object>Counters per user
array item fields →
1integerint32Contacts who's name begins with a non-alphabetic character
aintegerint32Contacts who's name begins with A
bintegerint32Contacts who's name begins with B
cintegerint32Contacts who's name begins with C
dintegerint32Contacts who's name begins with D
eintegerint32Contacts who's name begins with E
fintegerint32Contacts who's name begins with F
gintegerint32Contacts who's name begins with G
hintegerint32Contacts who's name begins with H
iintegerint32Contacts who's name begins with I
jintegerint32Contacts who's name begins with J
kintegerint32Contacts who's name begins with K
lintegerint32Contacts who's name begins with L
mintegerint32Contacts who's name begins with M
nintegerint32Contacts who's name begins with N
ointegerint32Contacts who's name begins with O
pintegerint32Contacts who's name begins with P
qintegerint32Contacts who's name begins with Q
rintegerint32Contacts who's name begins with R
sintegerint32Contacts who's name begins with S
tintegerint32Contacts who's name begins with T
uintegerint32Contacts who's name begins with U
vintegerint32Contacts who's name begins with V
wintegerint32Contacts who's name begins with W
xintegerint32Contacts who's name begins with X
yintegerint32Contacts who's name begins with Y
zintegerint32Contacts who's name begins with Z
total_countintegerint32user_idstringbson-idID of the user
team_streamobjectCounters showing the number of entries in the action stream. The `all` object represents the entire account, while the `users` array contains the same breakdown but per user.
object fields →
allintegerint32Counters for the entire account (`team_stream`/`action_stream?team=true`)
usersarray<object>Counters broken down per user (`team_stream?user_id={ID}`)
array item fields →
user_idstringbson-idID of the user
countsintegerint32The number of entries in the action steam for the user
Standard error responses: 400 · 401 · 403 · 404 · 409 · 500 — shared across the API. See Errors.