API Reference/Accounts/Update account proxy

Update account proxy

PATCHhttps://api.postpress.ai/v1/accounts/{id}

Update the proxy configuration of an existing account. Either provide a custom proxy under `proxy`, or request a postpress-managed proxy by passing a `country` and/or `ip`.

Authorization

X-API-KEYstringrequired
API key from your postpress dashboard. Sent as a request header.

Path parameters

idstringrequired
The id of the account to update.

Request body

All fields are optional. Provide either a custom proxy object, or country / ip to request a postpress-managed proxy.

proxyobject
Custom proxy configuration to attach to the account.
proxy object
hoststringrequired
Proxy host.
portnumberrequired
Proxy port.
protocolstring
httpshttpsocks5
Proxy protocol.
usernamestring
Optional username for proxy authentication.
passwordstring
Optional password for proxy authentication.
countrystringlength = 2
ISO 3166-1 alpha-2 country code to request a new postpress-managed proxy location.
Example: US
ipstring
IPv4 address used to infer the proxy country when requesting a postpress-managed proxy.
Example: 203.0.113.42

Response 200 OK

objectstringAccountPatchedrequired
account_idstringlength ≥ 1required
The id of the updated account.

Example request

{
  "proxy": {
    "protocol": "https",
    "host": "proxy.example.com",
    "port": 8080,
    "username": "proxyuser",
    "password": "********"
  }
}

Example response

{
  "object": "AccountPatched",
  "account_id": "acc_01HXYZ4QK3WJ8FN3M6QH7TZ8GR"
}

Errors

Every error response follows the same envelope:

titlestringrequired
Short error title.
detailstringoptional
Human-readable explanation.
instancestringoptional
Request identifier for support.
typestringrequired
Error type identifier, e.g. `errors/proxy_error`.
statusnumberrequired
HTTP status code.
400 Bad Request8 types

The request payload is invalid or missing required fields.

  • errors/invalid_parameters - One or more request parameters are invalid or missing.
  • errors/missing_parameters - One or more request parameters are missing.
  • errors/invalid_request - One or a combination of request parameters are invalid.
  • errors/malformed_request - The given request has been rejected by the provider.
  • errors/content_too_large - The request payload is too large for the provider.
  • errors/too_many_characters - The provided content exceeds the character limit.
  • errors/unescaped_characters - The request path contains unescaped characters.
  • errors/limit_too_high - Pagination limit too high. See API reference for details.
401 Unauthorized13 types

Credentials are missing, expired, or otherwise invalid.

  • errors/missing_credentials - Some credentials are necessary to perform the request.
  • errors/multiple_sessions - LinkedIn limits multiple sessions on certain Recruiter accounts. Use the cookie connection method.
  • errors/invalid_checkpoint_solution - The checkpoint resolution did not pass successfully. Retry.
  • errors/invalid_proxy_credentials - The provided proxy credentials are invalid.
  • errors/checkpoint_error - The checkpoint does not appear to be resolvable.
  • errors/invalid_credentials - The provided credentials are invalid.
  • errors/expired_credentials - Credentials have expired. Reconnect the account.
  • errors/insufficient_privileges - This resource is out of your API-key scopes.
  • errors/disconnected_account - The account is disconnected from the provider service.
  • errors/disconnected_feature - The service you're trying to reach is disconnected.
  • errors/invalid_credentials_but_valid_account_imap - IMAP/SMTP credentials are invalid but the account is otherwise valid.
  • errors/expired_link - This link has expired. Generate a new one.
  • errors/wrong_account - The provided credentials do not match the correct account.
404 Not Found2 types

The account id does not match any account on your workspace.

  • errors/resource_not_found - The requested resource was not found.
  • errors/invalid_resource_identifier - The provided identifier is not a valid account id.
500 Internal Server Error3 types

Something went wrong on our side or with the upstream provider.

  • errors/unexpected_error - Something went wrong.
  • errors/provider_error - The provider is experiencing operational problems. Retry later.
  • errors/authentication_intent_error - The current authentication intent was killed after failure. Start again from the beginning.
501 Not Implemented1 types

Proxy update is not supported for this account provider yet.

  • errors/feature_not_implemented - Requested feature is planned but has not been implemented yet.
502 Bad Gateway1 types

The configured proxy could not be reached or rejected the connection.

  • errors/proxy_error - The proxy in use is not working. Please try again.
503 Service Unavailable5 types

postpress is temporarily unable to handle the request.

  • errors/no_client_session - No client session is currently running.
  • errors/no_channel - No channel to client session.
  • errors/no_handler - Handler missing for that request.
  • errors/network_down - Network is down on the server side. Retry shortly.
  • errors/service_unavailable - Service temporarily unavailable. Retry later.
504 Gateway Timeout1 types

The upstream provider did not respond in time.

  • errors/request_timeout - Request timed out. Retry, and contact support if it persists.
Updated May 2026