SHshipsecai
integrations

POST /api/v1/integrations/connections/{id}/refresh

Changed on

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/api/v1/integrations/connections/{id}/refresh
  • Auth
    none declared

Path parameters

idstring required

Request body

userIdstring required

Application user identifier that owns the connection

Response

idstring required
providerstring required
providerNamestring required
userIdstring required
scopesstring[] required
tokenTypestring required
expiresAtstring
createdAtstring required
updatedAtstring required
status'active' | 'expired' required
supportsRefreshboolean required
hasRefreshTokenboolean required
metadataobject

Provider-specific metadata saved alongside the connection

Changes