--- title: Toggle Finance Offer Availability slug: api-documentation/toggle-finance-offer-availability docTags: createdAt: 2026-08-27T16:56:05.859Z --- { "id": "DCHLnmK0K-S8xo6Q00jj9", "type": "api-oas-v2", "data": { "method": "PATCH", "url": "https://api.upstartcommerce.com/v1/finance-offers/{offerId}", "servers": [ { "url": "https://api.upstartcommerce.com/v1/finance-offers/{offerId}" } ], "name": "Toggle Finance Offer Availability", "description": "

This endpoint allows administrators to switch a binary toggle to set the state of the indicated finance offer.

\n

Authorized permissions:

\n", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "offerId", "type": "string", "description": "The offer id used for lookups.", "format": "uuid" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "required", "name": "x-upstart-tenant", "type": "string", "description": "Tenant identifier associated with the site this call is for." }, { "kind": "required", "name": "if-unmodified-since", "type": "string", "example": "2017-07-21T17:32:28Z", "description": "

In the case of modifying a resource, this header is sent in the request to indicate when the resource was last pulled-support optimistic locking.\nSee also the \"last-modified\" header in the associated GET request. This value should be pulled from that header and set as the value of this request.

", "format": "date-time" }, { "kind": "required", "name": "if-match", "type": "string", "example": "c8e2f90c27be55855f094477e24d6650", "description": "This should be set to the value of the etag header returned in the associated GET request." } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "customType": "UpdateFinanceOfferAvailability", "schema": [ { "name": "enabled", "kind": "required", "type": "boolean", "description": "" } ], "modelRef": "#/components/schemas/UpdateFinanceOfferAvailability", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "NoChannelPortalAccess", "name": "NoChannelPortalAccess", "kind": "optional", "type": "http", "description": "

This authentication is required for clients to interact with any of the management APIs. Similar to 'LoggedIn', it indicates that the user has actually logged into the system, but in this case with a management role.

", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "

Success-finance offer availability state updated.

", "jsonExample": "", "isExpanded": true, "headers": [ { "kind": "optional", "name": "etag", "description": "" }, { "kind": "optional", "name": "last-modified", "description": "" } ], "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "FinanceOfferAvailability", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "", "format": "uuid" }, { "name": "enabled", "kind": "required", "type": "boolean", "description": "" } ], "modelRef": "#/components/schemas/FinanceOfferAvailability", "isExpanded": true } ] }, { "statusCode": "400", "description": "The request contained information that the server was unable to process. Appropriate errors are provided in the response body.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ValidationErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "optional", "type": "object", "description": "", "complexType": "oneOf", "complexItems": [], "schema": [] } ], "modelRef": "#/components/schemas/ValidationErrorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "403", "description": "

An update to this resource requires the if-match and if-unmodified-since headers to be sent in order to process the request.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "404", "description": "The requested resource was not found in the NoChannel system.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "409", "description": "The copy of the resource you are modifying has been changed on the server. This request has not been processed to prevent data loss.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "SkmExxyTn2h5V2BJ4MwmR", "language": "curl", "label": "cURL", "code": "curl --request PATCH \\\n --url https://api.upstartcommerce.com/v1/finance-offers/{offerId} \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --header 'x-upstart-tenant: string' \\\n --header 'if-unmodified-since: 2017-07-21T17:32:28Z' \\\n --header 'if-match: c8e2f90c27be55855f094477e24d6650' \\\n --data '{\n \"enabled\": \"\"\n }'" }, { "id": "Z_cyuwlCvU5kUeQfcR4zw", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-upstart-tenant\", \"string\");\nmyHeaders.append(\"if-unmodified-since\", \"2017-07-21T17:32:28Z\");\nmyHeaders.append(\"if-match\", \"c8e2f90c27be55855f094477e24d6650\");\n\nvar raw = JSON.stringify({\n \"enabled\": \"\"\n});\n\nvar requestOptions = {\n method: 'PATCH',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/v1/finance-offers/{offerId}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "WGrCXrCs2WjdEyQywGwad", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/finance-offers/{offerId}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Patch.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\nrequest[\"if-unmodified-since\"] = \"2017-07-21T17:32:28Z\"\nrequest[\"if-match\"] = \"c8e2f90c27be55855f094477e24d6650\"\nrequest.body = JSON.dump({\n \"enabled\": \"\"\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "aYbJqYEc_VJwLcYkeu9FL", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/finance-offers/{offerId}\"\n\npayload = json.dumps({\n \"enabled\": \"\"\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string',\n 'if-unmodified-since': '2017-07-21T17:32:28Z',\n 'if-match': 'c8e2f90c27be55855f094477e24d6650'\n}\n\nresponse = requests.request(\"PATCH\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "SkmExxyTn2h5V2BJ4MwmR" }, "results": { "languages": [ { "id": "Pv-iJ4v2bkUbO-25kqA-4", "language": "200", "code": "// Success-finance offer availability state updated.\n{\n \"id\": \"\",\n \"enabled\": false\n}" }, { "id": "diZ4bClXMRFBnEEmRWOFE", "language": "400", "code": "// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": {}\n}" }, { "id": "PXtGmc6ZLK4wWfJav-RSk", "language": "401", "code": "// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "XWy_7xYy6ZIq_-S4FjcmS", "language": "403", "code": "// An update to this resource requires the if-match and if-unmodified-since headers to be sent in order to process the request.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "BkpLIZyJYcOXUA7hSjCzO", "language": "404", "code": "// The requested resource was not found in the NoChannel system.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "3Q33doAlkBg1rKcvCF5vC", "language": "409", "code": "// The copy of the resource you are modifying has been changed on the server. This request has not been processed to prevent data loss.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" } ], "selectedLanguageId": "Pv-iJ4v2bkUbO-25kqA-4" } }, "children": [ { "text": "" } ] }