Sail

Force Refresh

POST/users/{user_id}/connections/{connection_id}/refresh

Triggers an asynchronous sync of this connection’s data. Requires the connections key scope.

Path Parameters

user_idstringrequired

The Sail user id.

connection_idstringrequired

The Sail connection id.

Response

Refresh job accepted.

statusstring

The job’s current status.

job_idstring

Identifier for tracking this asynchronous job.

Standard error envelope covering 400, 401, 403, 404, 429, and 500.

errorobject

The error detail.

Show error properties
codestring

Machine-readable code, e.g. not_found, token_scope_mismatch, product_not_enabled, insufficient_key_scope, insufficient_token_scope, user_token_required, user_token_expired, invalid_user_token, invalid_key_configuration, connection_not_reconnectable, rate_limited.

messagestring

Human-readable error message. May change, so match on error.code instead.

paramstring

The request field that caused the error, when applicable. Null otherwise.

Request
curl -X POST "https://live.savewithsail.com/api/v1/users/<user_id>/connections/<connection_id>/refresh" \
  -H "Authorization: Bearer <token>"
Response
{
  "status": "processing",
  "job_id": "string"
}