Skip to navigation

Close a contact request

View as Markdown

Closes a pending, accepted or held contact request in your directory, at any project status. Declined or already closed requests can’t be closed, and a closed request can’t be accepted, declined, reopened or have its project status changed. closeReason is required: wrong_partner, handled_by_us, partner_unresponsive, spam, duplicate, customer_withdrew or other. Send closeReasonDetail (up to 500 characters) only with other, where it is required. Set notifyPartner to true to email the partner when closing a pending or accepted request; it defaults to false, and the customer who sent the request is never emailed. Set blockSender to true, only with spam, to also block the sender’s email address in this directory. Closing a pending or accepted request sends a contact_request_updated webhook event. Closing a held request, which was never delivered, sends no webhook and no partner email, even with notifyPartner: true.

Authentication

AuthorizationToken

Your API key, sent as Authorization: Token <your API key>

Path parameters

contactIdstringRequiredformat: "uuid"
ID of the contact request to close

Request

This endpoint expects an object.
closeReasonenumRequired
  • wrong_partner - Wrong partner
  • handled_by_us - Handled by us
  • partner_unresponsive - Partner unresponsive
  • spam - Spam
  • duplicate - Duplicate
  • customer_withdrew - Customer withdrew
  • other - Other
notifyPartnerbooleanOptionalDefaults to false
closeReasonDetailstring or nullOptional<=500 characters
blockSenderbooleanOptionalDefaults to false

Response

firstNamestring<=50 characters
lastNamestring<=50 characters
emailstringformat: "email"
companyNamestring<=255 characters
hrefstringRead-only
idstringformat: "uuid"
createdstringRead-only
statestring
projectStatusenum or null
  • new - New
  • contacted - Contacted
  • engaged - Engaged
  • on_hold - On hold
  • secured - Secured
  • launched_deployed - Launched / Deployed
  • lost - Lost
entrymap from strings to any
directorymap from strings to any
sourceenum
  • matchmaking - Matchmaking
  • contact_request - Contact Request
Allowed values:
matchOriginstring or nullformat: "uuid"
customFormstringRead-only
eventslist of objects
firstViewedAtdatetime or null
phonestring or nullOptional<=30 characters
companyWebsitestring or nullOptional<=255 characters
commentsstring or nullOptional<=1000 characters
utmQueryParamsanyOptional
customFormResponseIdstringOptionalformat: "uuid"
declineReasonstring or nullOptional
declineReasonDetailstring or nullOptional
closeReasonstring or nullOptional
closeReasonDetailstring or nullOptional
routingSourcestring or nullOptional
isStalebooleanOptional
daysWaitingintegerOptional>=0
reminderCountintegerOptional>=0
holdReasonenum or nullOptional
  • same_message - Same message already sent to 2 partners today
  • same_phone - Same phone number already sent to 2 partners today
  • same_company - Same company already sent to 2 partners today
Allowed values:
reminderobjectOptional
senderBlockedbooleanOptional
closeNotificationRecipientslist of stringsOptional
deliveryobjectOptional

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error