Submit work-email verification feedback

Request

Submit verification feedback for a work email address returned by a Forager person lookup. Required fields: email and contact_status (one of valid or invalid). Optional: is_correct_person — omit it, or send null, when the exchange never revealed whose address it is; null means "unknown" and is deliberately distinct from false ("this is the wrong person"). Also optional: name and person_id. Reports for the same address via both the work and personal endpoints store two distinct rows distinguished by email type.

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/work_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"
}