Toggle Finance Offer Availability

1 min

PATCH

https://api.upstartcommerce.com/v1/finance-offers/{offerId}

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

Authorized permissions:

finance-offer.update

offerIdstring<uuid>The offer id used for lookups.

acceptstringGenerated from available response content types

x-upstart-tenantstringTenant identifier associated with the site this call is for.

if-unmodified-sincestring<date-time>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. See 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.

if-matchstringThis should be set to the value of the etag header returned in the associated GET request.

bodyobject

200Success-finance offer availability state updated.

400The request contained information that the server was unable to process. Appropriate errors are provided in the response body.

401The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.

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

404The requested resource was not found in the NoChannel system.

409The copy of the resource you are modifying has been changed on the server. This request has not been processed to prevent data loss.

curl --request PATCH \
     --url https://api.upstartcommerce.com/v1/finance-offers/{offerId} \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-upstart-tenant: string' \
     --header 'if-unmodified-since: 2017-07-21T17:32:28Z' \
     --header 'if-match: c8e2f90c27be55855f094477e24d6650' \
     --data '{
     "enabled": ""
     }'