Create EasyPost Connection
POST/api/easypost/instances
Connects EasyPost. The key is verified live first — an invalid key creates nothing. Returns 422 with code: already_connected when the account already has an EasyPost connection.
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. - name (string, optional, max 255): display name
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
- 201
- 401
- 403
- 422
- 429
Created
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.