Skip to main content

Update Integration Instance

PUT 
/api/veracore/integration-instances/:integration_instance

Update a Veracore integration instance.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Authentication: Requires Bearer token.

Veracore timestamps: set integration_settings.provider_timezone to the IANA timezone the Veracore account renders its dates in (e.g. America/Chicago). Veracore returns ship dates with no UTC offset, so an unset or incorrect value reports shipments hours away from when they actually happened. Defaults to UTC.

Requires the integrations.update permission.

Partial update: integration_settings keys that are not sent keep their current values (they are no longer reset to defaults), so a client can save one setting at a time. An explicitly sent value, including null, is applied.

Omitting fulfillment_cost_financial_line_type_id keeps the configured cost line type; send it (or null) to change it.

connection_settings never contains saved credentials: each secret key (API keys, secrets, passwords, tokens) is left out and replaced by a has_<snake_case_key> boolean saying whether one is saved (apiKey → has_api_key, password → has_password). Credentials in connection_settings are merged into the saved ones: a key you leave out keeps its saved value, so send a secret only to replace it (the response never echoes it back).

Request​

Responses​

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