Contact check

Send a test contact check

POST/v1/integration/contact-check-endpoint/test

Sends a signed contact check for a sample person (`ref` `src_0`) to your endpoint now, and reports whether Alfa could use the answer. Requires an API key with the `webhooks:manage` scope.

Requires an Alfa API key as a bearer token. How API keys work

Headers

Alfa-Company-Idstring
The Company ID of the company to act for. Required with a platform key, and that company must have authorized your platform; a company key acts for its own company and can leave it out.

Response body

answeredbooleanrequired
Whether your endpoint gave a clear answer for the sample person.
contactableboolean | nullrequired
Your answer for the sample person; null when there was no clear answer.
statusCodeinteger | nullrequired
The status your endpoint answered with; null when it could not be reached.
durationMsintegerrequired
How long the request took.
errorstring | nullrequired
Why the answer was not usable, when it was not. Outreach would not be sent.

Responses

200Success.
400The request is malformed: invalid JSON, an unexpected body or an unknown query parameter. Problem details
401The bearer token is missing, expired or invalid. Problem details
403The caller may not perform this operation, or has no active organisation. Problem details
404The resource does not exist or is not visible to the caller. Problem details
422The request failed validation; `errors` lists each invalid field. Problem details
429Too many requests, or the AI service is busy. Retry after a short wait. Problem details
500An unexpected error. Quote the `correlationId` to support. Problem details

Request

# Platform keys only: add -H "Alfa-Company-Id: org_2abcDEF123"
curl -X POST "https://api.welovealfa.com/v1/integration/contact-check-endpoint/test" \
  -H "Authorization: Bearer $ALFA_API_KEY"

Response

{
  "answered": true,
  "contactable": true,
  "statusCode": 200,
  "durationMs": 182,
  "error": null
}