POST
Rotate the signing secret

Authorizations

Authorization
string
header
required

sk_test_ / sk_live_ / rk_test_ / rk_live_ keys

Headers

Shipping-Version
string
Shipping-Account
string

Act on behalf of a connected account (acct_...)

Idempotency-Key
string
Maximum string length: 255

Path Parameters

id
string
required

Body

application/json
expire_previous_in
integer
default:86400
Required range: 0 <= x <= 604800

Response

OK

id
string
required

Prefixed we_

Example:

"we_1Q2w3E4r"

object
enum<string>
required
Available options:
webhook_endpoint
livemode
boolean
required
created
integer<unix-time>
required

Unix timestamp (seconds)

url
string<uri>
required
enabled_events
string[]
required
status
enum<string>
required
Available options:
enabled,
disabled,
auto_disabled
updated
integer<unix-time>

Unix timestamp (seconds)

description
string | null
api_version
string
filters
object
secret
string | null

Only returned on create and rotate_secret

secret_preview
string
disabled_reason
string | null
delivery
object
user_metadata
object

Client-writable. Up to 50 string key/value pairs. Never sent to carriers.

carrier_metadata
object
read-only

Read-only. Carrier-returned data not modelled by the spec (routing codes, internal IDs). Untrusted and unversioned; keys may change with the carrier's API.

system_metadata
object
read-only

Read-only. Implementer provenance. Implementer-specific keys are prefixed x_.