Skip to content

Feedback

Report verification feedback for contact data (phone numbers, personal emails, work emails) returned by Forager person lookups. Use these endpoints to submit whether a contact value is valid/invalid and whether it belongs to the matched person — every submission is stored as a new row and is used to improve the accuracy of future lookups.

Operations

Submit personal-email verification feedback

Request

Submit verification feedback for a personal email address returned by a Forager person lookup. Required fields: email (lowercased and stripped before storage) and contact_status (one of valid or invalid). Optional: is_correct_person (boolean) — omit it, or send null, when the exchange never revealed whose address it is; an invalid address bounces before anyone can confirm a name. Omitted and null are both stored and returned as null, meaning "unknown", which is deliberately distinct from false ("this is the wrong person"). Also optional: name (the person's name the email belongs to, e.g. John Doe) and person_id. Every submission creates a new row with 201 Created.

Security
Api-Key
Path
account_idintegerrequired
Body
required
is_correct_personboolean or null
namestring or null, <= 255 characters
person_idinteger or null
emailstring, (email)write-onlyrequired
contact_statusstring(EmailFeedbackRequestContactStatusEnum)required
  • valid - Valid
  • invalid - Invalid
Enum:"valid""invalid"
curl -i -X POST \
  'https://api-v2.forager.ai/api/{account_id}/datastorage/feedback/personal_emails/' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "is_correct_person": true,
    "name": "string",
    "person_id": 0,
    "email": "user@example.com",
    "contact_status": "valid"
  }'

Responses

Bodyapplication/json
idintegerread-onlyrequired
emailstringread-onlyrequired
contact_statusstringread-onlyrequired
is_correct_personboolean or nullread-onlyrequired
namestring or nullread-onlyrequired
person_idinteger or nullread-onlyrequired
date_createdstring, (date-time)read-onlyrequired
Response
{
  "id": 0,
  "email": "string",
  "contact_status": "string",
  "is_correct_person": true,
  "name": "string",
  "person_id": 0,
  "date_created": "2019-08-24T14:15:22Z"
}