ADM-BUYING-POLICY-202 - Update a credit hold

Updates a credit hold for a specific Customer Account.


⚠️ To update the endDate of an existing hold, you must also provide a startDate value.

This startDate must either:

  • match the current startDate of the hold,
  • or be a date greater than or equal to the credit hold creation date.


    This ensures that updating an endDate does not unintentionally affect the initial start date of the block.


    ⚠️ This endpoint is only accessible when the dj-client header is set to OPERATOR.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
date-time | null

The end date and time of the credit hold. If null, the credit hold is permanent.

date-time
required

Start date and time of the credit hold.
Required if you update endDate.

Headers
string
enum
required

Specifies the client type making the request.

  • OPERATOR: Platform operator user.

  • ACCOUNT: Customer account user.

  • SUPPLIER: Supplier managing orders.

Allowed:
string
required

API key required for authentication. Must be valid and linked to the requesting user.

string

(Optional) Store ID in multi-store environments.

string

(Optional) Store view ID in multi-store environments.

Responses
204

Credit hold successfully updated.

400

Invalid request payload. This error occurs when:

  • Required field startDate is missing or empty
  • Date formats are invalid (must be ISO 8601: YYYY-MM-DDTHH:MM:SSZ)
  • startDate is earlier than creation date
  • endDate is earlier than startDate

    Please verify that all required fields are present and properly formatted.
401

Authentication required.

403

Access forbidden.

404

Credit hold not found.

500

Internal server error.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here!