Update EasyPost Connection

PATCH 
/api/easypost/instances/:integrationInstance

Renames the connection and/or replaces its API key. A new key is verified live before it is saved.

Required scope: integrations:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Body fields (all optional):

• api_key (string): EasyPost API key, 16–255 characters, starting with EZTK (test mode) or EZAK (production mode). Whitespace is trimmed.
• name (string, max 255)

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.update

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

404

Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

422

Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.

429

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.