Start a line reputation audit

POST/v3/phone_numbers/{phoneNumber}/reputation_audit

Starts an asynchronous reputation audit for a line and returns an audit_id. Poll the GET endpoint for the result.

Rate limited per line: only one audit may run at a time. Starting one while another is still running returns 202 with the running audit’s audit_id rather than an error, so a retried start picks that audit back up instead of losing it — poll the id you were given.

Once an audit finishes, a new one can’t be started for the same line until a cooldown elapses (429, with Retry-After carrying the wait). Keep the audit_id from the original 202: it stays readable on the GET endpoint for 24 hours, and the cooldown response does not repeat it.

Path ParametersExpand Collapse

phoneNumber: string

ReturnsExpand Collapse

ReputationAuditStarted object { audit_id, status }

audit_id: string

Identifier for this audit. Poll GET /v3/phone_numbers/{phoneNumber}/reputation_audit/{auditId} until status is complete or error.

status: "pending" or "complete" or "error"

A newly started audit is pending.

One of the following:

"pending"

"complete"

"error"

Start a line reputation audit

curl https://api.linqapp.com/api/partner/v3/phone_numbers/$PHONE_NUMBER/reputation_audit \
    -X POST \
    -H "Authorization: Bearer $LINQ_API_V3_API_KEY"

{
  "audit_id": "audit_id",
  "status": "pending"
}

{
  "error": {
    "status": 401,
    "code": 2004,
    "message": "Unauthorized - missing or invalid authentication token",
    "doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/2xxx/2004/"
  },
  "success": false
}

{
  "error": {
    "status": 403,
    "code": 2005,
    "message": "Access denied - insufficient permissions for this resource",
    "doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/2xxx/2005/"
  },
  "success": false
}

{
  "error": {
    "status": 409,
    "code": 2013,
    "message": "This chat is unavailable",
    "doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/2xxx/2013/"
  },
  "success": false
}

{
  "error": {
    "status": 429,
    "code": 1007,
    "message": "Rate limited. Try again in 45 seconds.",
    "doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/1xxx/1007/",
    "retry_after": 45
  },
  "success": false
}

{
  "error": {
    "status": 500,
    "code": 3006,
    "message": "Internal server error",
    "doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/3xxx/3006/"
  },
  "success": false
}

Returns Examples

{
  "audit_id": "audit_id",
  "status": "pending"
}

{
  "error": {
    "status": 401,
    "code": 2004,
    "message": "Unauthorized - missing or invalid authentication token",
    "doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/2xxx/2004/"
  },
  "success": false
}

{
  "error": {
    "status": 403,
    "code": 2005,
    "message": "Access denied - insufficient permissions for this resource",
    "doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/2xxx/2005/"
  },
  "success": false
}

{
  "error": {
    "status": 409,
    "code": 2013,
    "message": "This chat is unavailable",
    "doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/2xxx/2013/"
  },
  "success": false
}

{
  "error": {
    "status": 429,
    "code": 1007,
    "message": "Rate limited. Try again in 45 seconds.",
    "doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/1xxx/1007/",
    "retry_after": 45
  },
  "success": false
}

{
  "error": {
    "status": 500,
    "code": 3006,
    "message": "Internal server error",
    "doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/3xxx/3006/"
  },
  "success": false
}