Preview Connection Name
POST/api/trackstar/connections/preview
Preview the WMS integration name for a connection before it is saved. Requires Bearer token.
Given an access token and connection ID, this looks up the matching connection and returns a suggested display name (e.g. "Mintsoft") so a create form can auto-default the integration name. No integration instance is created and nothing is persisted.
Request body fields:
- access_token (required, string): Access token for the connection
- connection_id (required, string): Identifier of the connection to look up
Response fields (under data):
- matched (boolean): Whether a connection matched the supplied connection ID
- connection_id (string): The connection ID that was looked up
- integration_name (string|null): Machine name of the matched WMS (e.g. "mintsoft")
- integration_display_name (string|null): Human-friendly WMS name (e.g. "Mintsoft")
- suggested_name (string|null): Recommended default name (display name, falling back to machine name)
- message (string|null): Explanation when no match was found or the lookup could not be completed
Request
Responses
- 200
- 401
- 403
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.