Skip to main content
PUT
Update Retailer Credentials
Update an existing managed account’s retailer credentials. Only provided fields are updated.

Path Parameters

  • short_id (required) - The short identifier of the credentials to update (e.g., zn_acct_a1b2c3d4)

Request Fields

All fields are optional. Only provided fields are updated.
  • email - New email address
  • password - New password (encrypted at rest)
  • retailer - New retailer association
  • totp_secret - Update the 2FA secret key (encrypted at rest)

Response

Returns the updated credential object.

Authorizations

Authorization
string
header
required

Zinc API key (Bearer zn_...)

Headers

authorization
string | null

Path Parameters

short_id
string
required

Body

application/json

Request model for updating retailer credentials.

email
string | null
password
string | null
retailer
string | null
totp_secret
string | null
retailer_config
Retailer Config · object | null

Response

Successful Response

Response model for retailer credentials.

id
string<uuid>
required
short_id
string
required
email
string
required
retailer
string | null
required
forwarding_email
string
required

Email address to forward retailer emails to for verification and 2FA code extraction.

created_at
string<date-time>
required
updated_at
string<date-time>
required
has_totp
boolean
default:false

Whether TOTP 2FA is configured for this account.

has_forwarding
boolean
default:false

Whether email forwarding has been verified for this account.

is_paused
boolean
default:false

Whether this credential is paused (jobs will not be picked up).

locked_by_job_id
string<uuid> | null

The job ID currently using this credential, if any.

cooldown_minutes
integer | null

Minimum minutes between uses. None = no cooldown.

last_used_at
string<date-time> | null

When this credential was last released after a job completed.

retailer_config
Retailer Config · object | null