Patch a Bid. Omitted fields are left unchanged; sending null
explicitly clears the field. Currently only externalId is
patchable. Returns the updated bid.
The current active counter on this bid, if any. Null when no counter
is in progress (or when the bid has never been countered).
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Cargado API Docs","colors":{"primary":"#345ED1","light":"#0EA5E9","dark":"#1F3A89"},"logo":{"light":"https://mintcdn.com/cargado/CLB1kJumWhQp7b97/cargado-logo-azul.png?fit=max\u0026auto=format\u0026n=CLB1kJumWhQp7b97\u0026q=85\u0026s=ce0b66ea21b97607c9feb1078d9e51ba","dark":"https://mintcdn.com/cargado/CLB1kJumWhQp7b97/cargado-logo-white.png?fit=max\u0026auto=format\u0026n=CLB1kJumWhQp7b97\u0026q=85\u0026s=e064cb372e3ce7708ef953d2d8c5a7e0"},"favicon":"https://mintcdn.com/cargado/Wapfgg7ZWTmU6W_z/cargado-favicon-azul.svg?fit=max\u0026auto=format\u0026n=Wapfgg7ZWTmU6W_z\u0026q=85\u0026s=6d3f2144bb002b78fea4fae5ce3ecdc7","api":{"openapi":{"source":"openapi.yml"},"mdx":{"auth":{"method":"bearer"},"server":"https://api.cargado.com"}},"navbar":{"links":[{"href":"mailto:dev-support@cargado.com","label":"Contact Us"}],"primary":{"type":"button","label":"Go to App","href":"https://app.cargado.com"}},"footer":{"socials":{"github":"https://github.com/cargadoinc","linkedin":"https://www.linkedin.com/company/cargado"}},"banner":{"content":"Cargado API is in beta. The API may change in breaking ways."},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cargado","hasAudioNarration":false,"actualSubdomain":"cargado","customDomains":["docs.cargado.com"],"gitSource":{"type":"github","owner":"cargadoinc","repo":"enchilada","deployBranch":"main","contentDirectory":"mintlify","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae25099322060d1d219d232","collectionId":"1795b56e-b12d-4102-87ae-c878c7f2c3c7","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae25099322060d1d219d232"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aee039dd121ed565e112f58","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"API Reference","count":29},{"language":"default","tag":"Concepts","count":9},{"language":"default","tag":"Guides","count":8},{"language":"default","tag":"Webhooks","count":8},{"language":"default","tag":"Webhook Events","count":3},{"language":"default","tag":"Carrier Relationships","count":3},{"language":"default","tag":"Load Sync","count":3},{"language":"default","tag":"Loads","count":2},{"language":"default","tag":"Rates","count":2},{"language":"default","tag":"Getting Started","count":2}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/bids/update-a-bid","slug":"/api-reference/bids/update-a-bid","pageMetadata":{"title":"Update a bid","description":"Patch a Bid. Omitted fields are left unchanged; sending null\nexplicitly clears the field. Currently only `externalId` is\npatchable. Returns the updated bid.","deprecated":null,"version":null,"openapi":"/openapi.yml post /bids/update","href":"/api-reference/bids/update-a-bid","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Patch a Bid. Omitted fields are left unchanged; sending null\\nexplicitly clears the field. Currently only \", _jsx(_components.code, {\n children: \"externalId\"\n }), \" is\\npatchable. Returns the updated bid.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update a bid","description":"Patch a Bid. Omitted fields are left unchanged; sending null\nexplicitly clears the field. Currently only `externalId` is\npatchable. Returns the updated bid.","deprecated":null,"version":null,"openapi":"/openapi.yml post /bids/update","href":"/api-reference/bids/update-a-bid","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"UpdateBid","responses":{"200":"ae98a27b-ac8c-4f79-a52b-2666c0bf8054","401":"e9446a0b-7c48-4976-aeef-f931dc1deb79","404":"51f19643-f655-45b2-9b6f-bcdfa6feda7f"},"description":"Patch a Bid. Omitted fields are left unchanged; sending null\nexplicitly clears the field. Currently only `externalId` is\npatchable. Returns the updated bid.","summary":"Update a bid","tags":["Bids"],"security":["349deaf2-c5b3-4b5e-b0e4-acd8f7110224"],"parameters":[],"requestBody":"e88c1110-cf22-4868-80e8-58ccb9f8ceb0","method":"post","type":"path","servers":["680435da-8bd8-44c0-bc61-09cd96d9e52e"],"path":"/bids/update","baseUrlOptions":["https://api.cargado.com"],"title":"Update a bid","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"description":"Patch a Bid. Omitted fields are left unchanged; sending a field with\n`null` explicitly clears it; sending a value sets it.","properties":{"bidId":{"type":"string","description":"The id of the Bid to update.","minLength":1,"maxLength":64,"isRequired":true,"uniqueKey":"bidId","typeLabel":"string"},"externalId":{"oneOf":[{"type":"string","description":"The id of the bid in the integration's TMS. Send a string to set,\n`null` to clear, or omit to leave unchanged.","minLength":1,"maxLength":255,"uniqueKey":"externalId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The id of the bid in the integration's TMS. Send a string to set,\n`null` to clear, or omit to leave unchanged.","minLength":1,"maxLength":255,"uniqueKey":"externalId.oneOf.1","typeLabel":"null"}],"uniqueKey":"externalId","typeLabel":"string | null"}},"required":["bidId"],"type":"object","additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"bidId":"\u003cstring>","externalId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"ae98a27b-ac8c-4f79-a52b-2666c0bf8054":{"description":"Ok","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","description":"Cargado-issued identifier for this bid (prefix: `bid_`).","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"status":{"type":"string","enum":["ACTIVE","ACCEPTED","REJECTED","REVOKED","COUNTERED","COUNTER_ACCEPTED","CLOSED"],"description":"The lifecycle status of a bid.\n\n- `ACTIVE` — the bid is live and awaiting a response from the broker.\n- `ACCEPTED` — the bid has been accepted by the broker.\n- `REJECTED` — the bid has been rejected by the broker.\n- `REVOKED` — the carrier withdrew the bid before a response.\n- `COUNTERED` — the broker has issued a counter on this bid.\n- `COUNTER_ACCEPTED` — a counter on this bid was accepted; the bid is\n settled at the countered rate.\n- `CLOSED` — the bid is no longer actionable (for example, the posting\n ended or another bid was accepted).","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"externalId":{"oneOf":[{"type":"string","description":"The unique id for this bid/offer object in your TMS. This identifier will not be displayed outside your organization.\nExamples: \"456293\", \"TMS232423\"","minLength":1,"maxLength":255,"examples":["456293"],"isRequired":true,"uniqueKey":"externalId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The unique id for this bid/offer object in your TMS. This identifier will not be displayed outside your organization.\nExamples: \"456293\", \"TMS232423\"","minLength":1,"maxLength":255,"examples":["456293"],"isRequired":true,"uniqueKey":"externalId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"externalId","typeLabel":"string | null"},"rateDetails":{"description":"Pricing details for this bid, broken out by line item.","properties":{"type":{"oneOf":[{"type":"string","enum":["ItemizedBid"],"isRequired":true,"uniqueKey":"rateDetails.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["ItemizedBid"],"isRequired":true,"uniqueKey":"rateDetails.type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"rateDetails.type","typeLabel":"enum\u003cstring> | null"},"totalAmount":{"description":"The total price offered for this bid, in the bid's currency.","properties":{"currencyCode":{"type":"string","enum":["USD","MXN","CAD"],"description":"The currency code of the amount","isRequired":true,"uniqueKey":"rateDetails.totalAmount.currencyCode","typeLabel":"enum\u003cstring>"},"amount":{"type":"integer","format":"int32","description":"The currency amount in the lowest denomination of the currency (e.g. cents)","minimum":0,"maximum":1000000000,"isRequired":true,"uniqueKey":"rateDetails.totalAmount.amount","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amount"],"type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"rateDetails.totalAmount","typeLabel":"object"},"lineItems":{"items":{"oneOf":[{"type":"object","description":"A single component of a bid's itemized pricing. Discriminated by `type`:\n`AllIn` for a single total, `CountryLeg` for per-country leg pricing on\ncross-border moves, and `BorderCrossing` for the fee charged at a\nspecific border crossing.","required":["type","totalAmount"],"properties":{"type":{"oneOf":[{"type":"string","enum":["AllIn"],"isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.0.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["AllIn"],"isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.0.type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring> | null"},"totalAmount":{"description":"The total amount being offered for the move.","properties":{"currencyCode":{"type":"string","enum":["USD","MXN","CAD"],"description":"The currency code of the amount","isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.0.totalAmount.currencyCode","typeLabel":"enum\u003cstring>"},"amount":{"type":"integer","format":"int32","description":"The currency amount in the lowest denomination of the currency (e.g. cents)","minimum":0,"maximum":1000000000,"isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.0.totalAmount.amount","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amount"],"type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.0.totalAmount","typeLabel":"object"}},"additionalProperties":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"A single component of a bid's itemized pricing. Discriminated by `type`:\n`AllIn` for a single total, `CountryLeg` for per-country leg pricing on\ncross-border moves, and `BorderCrossing` for the fee charged at a\nspecific border crossing.","required":["type","legCountry","legApproximateDistanceMiles","rate","totalAmount"],"properties":{"type":{"oneOf":[{"type":"string","enum":["CountryLeg"],"isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.1.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["CountryLeg"],"isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.1.type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring> | null"},"legCountry":{"type":"string","enum":["US","MX","CA"],"description":"The country this leg is in.","isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.1.legCountry","typeLabel":"enum\u003cstring>"},"legApproximateDistanceMiles":{"type":"number","format":"double","description":"Approximate distance covered in this country's portion of the move.","isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.1.legApproximateDistanceMiles","typeLabel":"number\u003cdouble>"},"rate":{"oneOf":[{"type":"object","description":"How this leg is priced — either a single fixed amount, or a per-distance\nrate paired with a distance unit.","required":["currencyValue","type"],"properties":{"currencyValue":{"description":"An object representing a monetary value in a given currency. Amount\nis in the lowest denomination of the currency (e.g. cents).\nFor example, $15.25 is represented as `{ currencyCode: 'USD', amount: 1525 }`.","properties":{"currencyCode":{"type":"string","enum":["USD","MXN","CAD"],"description":"The currency code of the amount","isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.1.rate.oneOf.0.currencyValue.currencyCode","typeLabel":"enum\u003cstring>"},"amount":{"type":"integer","format":"int32","description":"The currency amount in the lowest denomination of the currency (e.g. cents)","minimum":0,"maximum":1000000000,"isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.1.rate.oneOf.0.currencyValue.amount","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amount"],"type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.1.rate.oneOf.0.currencyValue","typeLabel":"object"},"type":{"oneOf":[{"type":"string","enum":["FIXED_AMOUNT"],"isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.1.rate.oneOf.0.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["FIXED_AMOUNT"],"isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.1.rate.oneOf.0.type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.1.rate.oneOf.0.type","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.1.rate.oneOf.0","typeLabel":"object"},{"type":"object","description":"How this leg is priced — either a single fixed amount, or a per-distance\nrate paired with a distance unit.","required":["distanceUnit","currencyValue","type"],"properties":{"distanceUnit":{"type":"string","enum":["MI","KM"],"isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.1.rate.oneOf.1.distanceUnit","typeLabel":"enum\u003cstring>"},"currencyValue":{"description":"An object representing a monetary value in a given currency. Amount\nis in the lowest denomination of the currency (e.g. cents).\nFor example, $15.25 is represented as `{ currencyCode: 'USD', amount: 1525 }`.","properties":{"currencyCode":{"type":"string","enum":["USD","MXN","CAD"],"description":"The currency code of the amount","isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.1.rate.oneOf.1.currencyValue.currencyCode","typeLabel":"enum\u003cstring>"},"amount":{"type":"integer","format":"int32","description":"The currency amount in the lowest denomination of the currency (e.g. cents)","minimum":0,"maximum":1000000000,"isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.1.rate.oneOf.1.currencyValue.amount","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amount"],"type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.1.rate.oneOf.1.currencyValue","typeLabel":"object"},"type":{"oneOf":[{"type":"string","enum":["RATE_PER_DISTANCE"],"isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.1.rate.oneOf.1.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["RATE_PER_DISTANCE"],"isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.1.rate.oneOf.1.type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.1.rate.oneOf.1.type","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.1.rate.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.1.rate","typeLabel":"object"},"totalAmount":{"description":"The total amount for this leg in the bid's currency.","properties":{"currencyCode":{"type":"string","enum":["USD","MXN","CAD"],"description":"The currency code of the amount","isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.1.totalAmount.currencyCode","typeLabel":"enum\u003cstring>"},"amount":{"type":"integer","format":"int32","description":"The currency amount in the lowest denomination of the currency (e.g. cents)","minimum":0,"maximum":1000000000,"isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.1.totalAmount.amount","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amount"],"type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.1.totalAmount","typeLabel":"object"}},"additionalProperties":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"A single component of a bid's itemized pricing. Discriminated by `type`:\n`AllIn` for a single total, `CountryLeg` for per-country leg pricing on\ncross-border moves, and `BorderCrossing` for the fee charged at a\nspecific border crossing.","required":["type","legOriginCountry","legDestinationCountry","legPort","totalAmount"],"properties":{"type":{"oneOf":[{"type":"string","enum":["BorderCrossing"],"isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.2.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["BorderCrossing"],"isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.2.type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring> | null"},"legOriginCountry":{"type":"string","enum":["US","MX","CA"],"description":"The country the freight is leaving.","isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.2.legOriginCountry","typeLabel":"enum\u003cstring>"},"legDestinationCountry":{"type":"string","enum":["US","MX","CA"],"description":"The country the freight is entering.","isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.2.legDestinationCountry","typeLabel":"enum\u003cstring>"},"legPort":{"type":"string","enum":["LAREDO_INTL_BRIDGE","LAREDO_COLUMBIA","BROWNSVILLE","CALEXICO_EAST","DEL_RIO","DOUGLAS","EAGLE_PASS","EL_PASO","HIDALGO","NOGALES","OTAY_MESA","SAN_LUIS","TECATE"],"description":"The specific border crossing used for this leg.","isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.2.legPort","typeLabel":"enum\u003cstring>"},"totalAmount":{"description":"The total amount being charged for the crossing, in the bid's currency.","properties":{"currencyCode":{"type":"string","enum":["USD","MXN","CAD"],"description":"The currency code of the amount","isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.2.totalAmount.currencyCode","typeLabel":"enum\u003cstring>"},"amount":{"type":"integer","format":"int32","description":"The currency amount in the lowest denomination of the currency (e.g. cents)","minimum":0,"maximum":1000000000,"isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.2.totalAmount.amount","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amount"],"type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.2.totalAmount","typeLabel":"object"}},"additionalProperties":true,"uniqueKey":"rateDetails.lineItems.items.[INDEX].oneOf.2","typeLabel":"object"}],"uniqueKey":"rateDetails.lineItems.items.[INDEX]","typeLabel":"object"},"type":"array","description":"The pricing components that make up `totalAmount`.","isRequired":true,"uniqueKey":"rateDetails.lineItems","typeLabel":"object[]"}},"required":["type","totalAmount","lineItems"],"type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"rateDetails","typeLabel":"object"},"loadsPerPeriod":{"oneOf":[{"type":"number","format":"double","description":"The number of loads the carrier is able to cover at this rate during\nthe lane period. Null for single-load bids; populated for lane bids.","minimum":0,"isRequired":true,"uniqueKey":"loadsPerPeriod.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","description":"The number of loads the carrier is able to cover at this rate during\nthe lane period. Null for single-load bids; populated for lane bids.","minimum":0,"isRequired":true,"uniqueKey":"loadsPerPeriod.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"loadsPerPeriod","typeLabel":"number\u003cdouble> | null"},"createdByName":{"oneOf":[{"type":"string","description":"The full name of the user who submitted the bid.","isRequired":true,"uniqueKey":"createdByName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The full name of the user who submitted the bid.","isRequired":true,"uniqueKey":"createdByName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"createdByName","typeLabel":"string | null"},"createdAt":{"type":"string","description":"The time the bid was created, as an ISO-8601 timestamp.","format":"date-time","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","description":"The time the bid was last updated, as an ISO-8601 timestamp.","format":"date-time","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"counterBid":{"oneOf":[{"type":"object","description":"The current active counter on this bid, if any. Null when no counter\nis in progress (or when the bid has never been countered).","required":["id","status","rateDetails","createdByName","createdAt"],"properties":{"id":{"type":"string","description":"Cargado-issued identifier for this counter (prefix: `cb_`).","isRequired":true,"uniqueKey":"counterBid.oneOf.0.id","typeLabel":"string"},"status":{"type":"string","enum":["ACTIVE","ACCEPTED","REJECTED","REVOKED","CLOSED"],"description":"The lifecycle status of a counter bid.\n\n- `ACTIVE` — the counter is live and awaiting a response from the carrier.\n- `ACCEPTED` — the counter has been accepted by the carrier.\n- `REJECTED` — the counter has been rejected by the carrier.\n- `REVOKED` — the counter was withdrawn before a response.\n- `CLOSED` — the counter is no longer actionable (for example, a newer\n counter superseded it).","isRequired":true,"uniqueKey":"counterBid.oneOf.0.status","typeLabel":"enum\u003cstring>"},"rateDetails":{"description":"Pricing details for this counter, broken out by line item.","properties":{"type":{"oneOf":[{"type":"string","enum":["SimpleCounterBid"],"isRequired":true,"uniqueKey":"counterBid.oneOf.0.rateDetails.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["SimpleCounterBid"],"isRequired":true,"uniqueKey":"counterBid.oneOf.0.rateDetails.type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"counterBid.oneOf.0.rateDetails.type","typeLabel":"enum\u003cstring> | null"},"totalAmount":{"description":"The total counter amount being offered.","properties":{"currencyCode":{"type":"string","enum":["USD","MXN","CAD"],"description":"The currency code of the amount","isRequired":true,"uniqueKey":"counterBid.oneOf.0.rateDetails.totalAmount.currencyCode","typeLabel":"enum\u003cstring>"},"amount":{"type":"integer","format":"int32","description":"The currency amount in the lowest denomination of the currency (e.g. cents)","minimum":0,"maximum":1000000000,"isRequired":true,"uniqueKey":"counterBid.oneOf.0.rateDetails.totalAmount.amount","typeLabel":"integer\u003cint32>"}},"required":["currencyCode","amount"],"type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"counterBid.oneOf.0.rateDetails.totalAmount","typeLabel":"object"}},"required":["type","totalAmount"],"type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"counterBid.oneOf.0.rateDetails","typeLabel":"object"},"createdByName":{"oneOf":[{"type":"string","description":"The full name of the broker-side user who sent the counter. Null for\ncounters generated automatically by instant response.","isRequired":true,"uniqueKey":"counterBid.oneOf.0.createdByName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The full name of the broker-side user who sent the counter. Null for\ncounters generated automatically by instant response.","isRequired":true,"uniqueKey":"counterBid.oneOf.0.createdByName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"counterBid.oneOf.0.createdByName","typeLabel":"string | null"},"createdAt":{"type":"string","description":"The time the counter was created, as an ISO-8601 timestamp.","format":"date-time","isRequired":true,"uniqueKey":"counterBid.oneOf.0.createdAt","typeLabel":"string\u003cdate-time>"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"counterBid.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"counterBid.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"counterBid","typeLabel":"object | null"}},"required":["id","status","externalId","rateDetails","loadsPerPeriod","createdByName","createdAt","updatedAt","counterBid"],"type":"object","additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","status":"ACTIVE","externalId":"456293","rateDetails":{"type":"ItemizedBid","totalAmount":{"currencyCode":"USD","amount":500000000},"lineItems":[{"type":"AllIn","totalAmount":{"currencyCode":"USD","amount":500000000}}]},"loadsPerPeriod":1,"createdByName":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","counterBid":{"id":"\u003cstring>","status":"ACTIVE","rateDetails":{"type":"SimpleCounterBid","totalAmount":{"currencyCode":"USD","amount":500000000}},"createdByName":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"e9446a0b-7c48-4976-aeef-f931dc1deb79":{"description":"Unauthorized","content":{"application/json":{"schema":{"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example 1":{"title":"Example 1","value":{"message":"Unauthorized"}}},"exampleType":"examples"}},"exampleType":"examples"},"51f19643-f655-45b2-9b6f-bcdfa6feda7f":{"description":"Not Found","content":{"application/json":{"schema":{"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example 1":{"title":"Example 1","value":{"message":"Bid with ID bid_… not found"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"349deaf2-c5b3-4b5e-b0e4-acd8f7110224":{"apiKey":{"type":"apiKey","in":"header","name":"api-key","scopes":[],"schemeName":"apiKey"}}},"servers":{"680435da-8bd8-44c0-bc61-09cd96d9e52e":{"url":"https://api.cargado.com","description":"The production Cargado API server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"api-key","scopes":[],"schemeName":"apiKey"},"schema":{"title":"api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"api-key"}],"title":"apiKey"}]},"originalFileLocation":"openapi.yml"},"subdomain":"cargado","siteName":"Cargado API Docs","title":"Update a bid - Cargado API Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-06T16:43:43.387Z","originalFileLocation":"api-reference/bids/update-a-bid.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Patch a Bid. Omitted fields are left unchanged; sending null explicitly clears the field. Currently only externalId is patchable. Returns the updated bid.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Cargado API Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cargado/cOUhh33AueWkmX39/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/cargado/cOUhh33AueWkmX39/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cargado/cOUhh33AueWkmX39/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/cargado/cOUhh33AueWkmX39/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/cargado/cOUhh33AueWkmX39/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cargado/cOUhh33AueWkmX39/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cargado/cOUhh33AueWkmX39/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/cargado/cOUhh33AueWkmX39/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/cargado/cOUhh33AueWkmX39/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update a bid - Cargado API Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Patch a Bid. Omitted fields are left unchanged; sending null explicitly clears the field. Currently only externalId is patchable. Returns the updated bid.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Cargado API Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.cargado.com/api-reference/bids/update-a-bid\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cargado.mintlify.site/_mintlify/api/og/v2?division=Bids\u0026amp;title=Update+a+bid\u0026amp;description=Patch+a+Bid.+Omitted+fields+are+left+unchanged%3B+sending+null%0Aexplicitly+clears+the+field.+Currently+only+%60externalId%60+is%0Apatchable.+Returns+the+updated+bid.\u0026amp;theme=0bb6f61263cf8b669742e88e\u0026amp;signature=ed1b6d547b330e3d8f3d72b8d68f01cd661c4de4dfdec06d561febf336f3e005\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update a bid - Cargado API Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Patch a Bid. Omitted fields are left unchanged; sending null explicitly clears the field. Currently only externalId is patchable. Returns the updated bid.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cargado.mintlify.site/_mintlify/api/og/v2?division=Bids\u0026amp;title=Update+a+bid\u0026amp;description=Patch+a+Bid.+Omitted+fields+are+left+unchanged%3B+sending+null%0Aexplicitly+clears+the+field.+Currently+only+%60externalId%60+is%0Apatchable.+Returns+the+updated+bid.\u0026amp;theme=0bb6f61263cf8b669742e88e\u0026amp;signature=ed1b6d547b330e3d8f3d72b8d68f01cd661c4de4dfdec06d561febf336f3e005\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/cargado/cOUhh33AueWkmX39/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Cargado API Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#345ED1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.cargado.com/api-reference/bids/update-a-bid\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/bids/update-a-bid.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.cargado.com/#organization\",\"name\":\"Cargado API Docs\",\"url\":\"https://docs.cargado.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cargado/CLB1kJumWhQp7b97/cargado-logo-azul.png?fit=max\u0026auto=format\u0026n=CLB1kJumWhQp7b97\u0026q=85\u0026s=ce0b66ea21b97607c9feb1078d9e51ba\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.cargado.com#website\",\"name\":\"Cargado API Docs\",\"url\":\"https://docs.cargado.com\",\"publisher\":{\"@id\":\"https://docs.cargado.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.cargado.com/api-reference/bids/update-a-bid#webpage\",\"url\":\"https://docs.cargado.com/api-reference/bids/update-a-bid\",\"name\":\"Update a bid\",\"description\":\"Patch a Bid. Omitted fields are left unchanged; sending null explicitly clears the field. Currently only externalId is patchable. Returns the updated bid.\",\"dateModified\":\"2026-11-06T16:43:43.387Z\",\"isPartOf\":{\"@id\":\"https://docs.cargado.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.cargado.com/api-reference/bids/update-a-bid#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.cargado.com/api-reference/bids/update-a-bid#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Cargado API Docs\",\"item\":\"https://docs.cargado.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update a bid\",\"item\":\"https://docs.cargado.com/api-reference/bids/update-a-bid\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.cargado.com/api-reference/bids/update-a-bid#apireference\",\"headline\":\"Update a bid\",\"name\":\"Update a bid\",\"description\":\"Patch a Bid. Omitted fields are left unchanged; sending null explicitly clears the field. Currently only externalId is patchable. Returns the updated bid.\",\"url\":\"https://docs.cargado.com/api-reference/bids/update-a-bid\",\"mainEntityOfPage\":{\"@id\":\"https://docs.cargado.com/api-reference/bids/update-a-bid#webpage\"},\"dateModified\":\"2026-11-06T16:43:43.387Z\",\"publisher\":{\"@id\":\"https://docs.cargado.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.cargado.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Cargado API Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Cargado API Docs","nav":{"global":null,"tabs":[{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":"/guides/overview"}]},{"tab":"API Reference","icon":"square-terminal","groups":[{"group":"Concepts","pages":[{"title":"Overview","href":"/api-reference/concepts/overview"},{"title":"Authorization and Testing","href":"/api-reference/concepts/auth-and-testing"},{"title":"Versioning","href":"/api-reference/concepts/versioning"},{"title":"OpenAPI","href":"/api-reference/concepts/openapi"},{"title":"Requests and Responses","href":"/api-reference/concepts/requests-and-responses"},{"title":"Identifiers","href":"/api-reference/concepts/identifiers"},{"title":"Pagination","href":"/api-reference/concepts/pagination"},{"title":"Errors","href":"/api-reference/concepts/errors"},{"title":"Metadata","href":"/api-reference/concepts/metadata"}]},{"group":"Loads","pages":[{"title":"Load object","href":"/api-reference/models/load"},{"title":"Sync a load","deprecated":null,"version":null,"openapi":"/openapi.yml post /loads/sync","href":"/api-reference/loads/sync-a-load"}]},{"group":"Rates","pages":[{"title":"RateHistoryLookup object","href":"/api-reference/models/rateHistoryLookup"},{"title":"Lookup rate history","deprecated":null,"version":null,"openapi":"/openapi.yml post /rates/history","href":"/api-reference/rates/lookup-rate-history"}]},{"group":"Market Rate Export","hidden":true,"pages":[{"title":"MarketRateExportRow","href":"/api-reference/models/MarketRateExportRow"},{"title":"Export market rate history","deprecated":null,"version":null,"openapi":"/openapi.yml get /rates/history-exports","href":"/api-reference/rates/export-market-rate-history"}]},{"group":"Border Crossings","pages":[{"title":"Get border crossing recommendations","deprecated":null,"version":null,"openapi":"/openapi.yml post /border-crossings/recommendations","href":"/api-reference/border-crossings/get-border-crossing-recommendations"}]},{"group":"Carrier Relationships","pages":[{"title":"CarrierRelationship object","href":"/api-reference/models/CarrierRelationship"},{"title":"Upsert carrier relationships","description":"Create or update carrier relationships and statuses from your TMS to Cargado.\nIf a carrier is not found, the relationship will be null.\nReturns the relationships in the same order and length as the input.","deprecated":null,"version":null,"openapi":"/openapi.yml post /carrier-relationships/upsert","href":"/api-reference/carrierrelationship/upsert-carrier-relationships"}]},{"group":"Bids","pages":[{"title":"Update a bid","deprecated":null,"version":null,"openapi":"/openapi.yml post /bids/update","href":"/api-reference/bids/update-a-bid"}]},{"group":"Users","pages":[{"title":"Update users by email","description":"Update user external IDs by email. Matches users in your organization by\nemail and assigns each an externalId for use in subsequent API calls\n(e.g., load sync coverage assignment).","deprecated":null,"version":null,"openapi":"/openapi.yml post /users/updateByEmail","href":"/api-reference/user/update-users-by-email"}]},{"group":"Teams","pages":[{"title":"Update teams by email","deprecated":null,"version":null,"openapi":"/openapi.yml post /teams/updateByEmail","href":"/api-reference/team/update-teams-by-email"}]},{"group":"Webhooks","pages":[{"title":"Register webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.yml post /webhooks/endpoint/register","href":"/api-reference/webhooks/register-webhook-endpoint"},{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/openapi.yml get /webhooks/endpoints","href":"/api-reference/webhooks/list-webhook-endpoints"},{"title":"Get webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.yml get /webhooks/endpoints/{endpointId}","href":"/api-reference/webhooks/get-webhook-endpoint"},{"title":"Update webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.yml post /webhooks/endpoint/update","href":"/api-reference/webhooks/update-webhook-endpoint"},{"title":"Delete webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.yml post /webhooks/endpoint/delete","href":"/api-reference/webhooks/delete-webhook-endpoint"},{"title":"Rotate endpoint secret","deprecated":null,"version":null,"openapi":"/openapi.yml post /webhooks/endpoint/rotateSecret","href":"/api-reference/webhooks/rotate-endpoint-secret"},{"title":"Test webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.yml post /webhooks/endpoint/test","href":"/api-reference/webhooks/test-webhook-endpoint"}]},{"group":"Webhook Events","pages":[{"title":"Event Types","href":"/api-reference/events/index"},{"title":"WebhookEvent object","href":"/api-reference/models/WebhookEvent"},{"title":"Bid events","version":null,"deprecated":null,"openapi":"/openapi.yml webhook bid","href":"/api-reference/bid-events"}]}]}]},"basePath":"","title":"Update a bid - Cargado API Docs","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}