DealSleek API · Connectors

Preview

Record Connector Verify Success

Report one passing live check: resets the failure counter, stamps last_verified_at / account count / token expiry, and recovers an ERROR binding to ACTIVE. Does not revive DISCONNECTED bindings.

POST/api/v1/connectors/dispatch

Authorization

Minimum role
ManagerThe caller must hold this role or a higher one.
Action
RECORD_CONNECTOR_VERIFY_SUCCESS

Headers

  • AuthorizationstringRequired

    Access token of the signed-in user, as a Bearer token. It identifies the user, their role and the workspace.

  • X-CQRS-ActionstringRequired

    Names the command to run. Must be RECORD_CONNECTOR_VERIFY_SUCCESS for this endpoint.

  • Content-TypestringRequired

    Always application/json.

  • X-Idempotency-KeystringRequired

    A key you choose that is unique to this attempt. A command repeated with the same key is not applied a second time.

  • X-Correlation-IdstringOptional

    Your own identifier for the request. Returned in the x-correlation-id response header; generated when you leave it out.

Request body

  • binding_iduuidRequired

    No description yet.

  • tenant_iduuidRequired

    No description yet.

  • account_countinteger or nullOptional

    Accessible provider accounts the check saw; None when the caller (token rotation, metrics poll) did not enumerate accounts.

  • token_expires_in_secondsinteger or nullOptional

    Fresh token lifetime when the check also rotated the token.

Response

Status 202. The command was applied. The body is the record as it stands after the command: a JSON object whose fields depend on the record.

Errors

Every error carries an HTTP status. Where it also carries a code, branch on the code, not on the message.

  • 400X-CQRS-Action is missing or names a command this route does not accept. Send RECORD_CONNECTOR_VERIFY_SUCCESS.
  • 400DOMAIN_ROUTINGThe body is not a valid command. Check the required fields and their types.
  • 400IDEMPOTENCY_KEY_REQUIREDX-Idempotency-Key is missing.
  • 401The access token is missing, expired or not valid.
  • 401L1_AUTHThe caller's role is below manager or the caller has no access to this record.
  • 403L1_POLICYA business rule refused the command. The message names the rule.
  • 409L1_IDEMPOTENCYA command with this idempotency key was already applied.
  • 409CONFLICTThe command would duplicate a record that must be unique.
  • 500L3_COMMITThe command was valid but could not be saved.
Generated from the API contract · revision 81ff3aa932f37d3b