Sign in
Connections

Test platform connection health

Validate that a platform connection is working correctly. Returns token status, permissions, and last error if any.

post/test-connection/{platformId}

Path parameters

platformIdstring required

Platform connection ID (format: platform-id)

Response

Connection test result

platformstring
platformIdstring
usernamestring
status'ok' | 'error'
messagestring
permissionsstring[]
tokenExpiresInstring nullable
lastSuccessfulPoststring date-time nullable

Example response

{
  "platform": "linkedin",
  "platformId": "linkedin-Tz9W5i6ZYG",
  "username": "John Doe",
  "status": "ok",
  "message": "Connection is valid",
  "permissions": [
    "w_member_social",
    "r_basicprofile"
  ],
  "tokenExpiresIn": "29 days"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.