Skip to content

Submit phone-number verification feedback

Request

Submit verification feedback for a phone number returned by a Forager person lookup. Required fields: phone_number (any format; it is normalised to E.164 before storage) and contact_status (one of connected or disconnected, reflecting the live-call outcome). Optional: is_correct_person (boolean — did the call confirm the number belongs to the matched person). Omit it, or send null, when the call could not answer that question — a disconnected number never reaches anyone, so there is nobody to identify. 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 caller believes the number belongs to, e.g. John Doe) and person_id (associate the row with a specific Forager person ID). Every submission creates a new row with 201 Created; repeat submissions for the same contact are preserved as separate rows.

Security
Api-Key
Path
account_idintegerrequired
Bodyrequired
is_correct_personboolean or null
namestring or null, <= 255 characters
person_idinteger or null
phone_numberstringwrite-onlyrequired
contact_statusstring(PhoneFeedbackRequestContactStatusEnum)required
  • connected - Connected
  • disconnected - Disconnected
Enum:"connected""disconnected"
curl -i -X POST \
  'https://api-v2.forager.ai/api/{account_id}/datastorage/feedback/phone_numbers/' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "is_correct_person": true,
    "name": "string",
    "person_id": 0,
    "phone_number": "string",
    "contact_status": "connected"
  }'

Responses

Bodyapplication/json
idintegerread-onlyrequired
phone_numberstringread-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, "phone_number": "string", "contact_status": "string", "is_correct_person": true, "name": "string", "person_id": 0, "date_created": "2019-08-24T14:15:22Z" }