Test Connection
Check a connection against the provider it signs into. A test writes only its result: the status, the last successful test time, a renewed sign-in for an app that can renew one, and a refreshed name when the name was generated (a name someone typed never changes). changes lists exactly which of these moved. An app with no connection test answers 200 with supported false and status "unsupported" and changes nothing. Parent delegation cannot test Embedded end-user or installation connections. A key tests only the connections its creator may use: shared ones, and their own personal ones.
Path
The connection's id, from List Connections.
Headers
Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. A key can also act in its child organizations, and, with "Use this key across all of your organizations" on, in every organization its creator can open in the app. List them with GET /v2/companies. Every response's X-Company-Id header names the organization it acted in. See Organizations.
Response fields
supportedbooleanFalse when the app declares no connection test; then no test ran.
statusstringThe verdict: the stored connection status after the test, or "unsupported".
testedOndateWhen the test ran.
messagestringWhy the test failed or could not run. Empty when it passed.
changesarray of objectsEach field of the connection the test moved, with its value before and after. Empty when it moved nothing, as when the app declares no test.
fieldstringThe connection field that moved.
statusThe verdict changed the stored status.testedOnThe test passed, so it is the last successful test.authenticatedOnThe sign-in was renewed before the test, for an app that can renew one.expiresOnThe renewed sign-in expires at a new time.nameA generated name was refreshed from the account the provider reported. A name someone typed is never changed.
fromobjectIts value before the test.
toobjectIts value after the test.