Test EasyPost API Key
POST/api/easypost/test
Checks an unsaved EasyPost API key live against EasyPost. Nothing is persisted. mode is derived from the key prefix.
integrations:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Body fields:
- api_key (string, required): EasyPost API key, 16–255 characters, starting with
EZTK(test mode) orEZAK(production mode). Whitespace is trimmed.
EasyPost failures return 422 (or 502 when EasyPost is unreachable) with message, code (EasyPost's error code, e.g. APIKEY.INACTIVE, CONNECTION_FAILED) and errors.api_key.
Authentication: Requires Bearer token.
Requires permission: integrations.create
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.