Delete a client

https://api.playground.kustom.co/elements/v1/clients/{clientId}

Removes an API client owned by the merchant from the system.

Parameters

200

400

401

502

Example

Parameters2 fields

• clientIdstringrequiredin path

  Client identifier

• x-merchant-idstringrequiredin header

  Merchant identifier used to scope the client

200

Response0 fields

OK

No response body — this status returns headers only.

400

Response4 fields

Bad Request

• messagestringoptional
• additional_contextobjectoptional
  1 field in additional_context

  • keystringoptional

    Any additional property. The key is free-form; the value has this shape.

• codestringoptional
  • CLIENT_NOT_FOUND
  • ORIGIN_NOT_ALLOWED
  • HTTP_CLIENT_ERROR
  • HTTP_SERVER_ERROR
  • DOMAIN_NOT_WHITELISTED
  • PLACEMENT_CONFIG_MISSING
  • ARGUMENT_NOT_VALID
  • CONSTRAINT_VIOLATION
  • PROFILE_DOESNT_BELONG_TO_MERCHANT
  • MERCHANT_NOT_FOUND

401

Response4 fields

Unauthorized

• messagestringoptional
• additional_contextobjectoptional
  1 field in additional_context

  • keystringoptional

    Any additional property. The key is free-form; the value has this shape.

• codestringoptional
  • CLIENT_NOT_FOUND
  • ORIGIN_NOT_ALLOWED
  • HTTP_CLIENT_ERROR
  • HTTP_SERVER_ERROR
  • DOMAIN_NOT_WHITELISTED
  • PLACEMENT_CONFIG_MISSING
  • ARGUMENT_NOT_VALID
  • CONSTRAINT_VIOLATION
  • PROFILE_DOESNT_BELONG_TO_MERCHANT
  • MERCHANT_NOT_FOUND

502

Response4 fields

Bad Gateway

• messagestringoptional
• additional_contextobjectoptional
  1 field in additional_context

  • keystringoptional

    Any additional property. The key is free-form; the value has this shape.

• codestringoptional
  • CLIENT_NOT_FOUND
  • ORIGIN_NOT_ALLOWED
  • HTTP_CLIENT_ERROR
  • HTTP_SERVER_ERROR
  • DOMAIN_NOT_WHITELISTED
  • PLACEMENT_CONFIG_MISSING
  • ARGUMENT_NOT_VALID
  • CONSTRAINT_VIOLATION
  • PROFILE_DOESNT_BELONG_TO_MERCHANT
  • MERCHANT_NOT_FOUND

DELETE https://api.playground.kustom.co/elements/v1/clients/{clientId}

Response200400401502

Response 200· OK

No response body.

This status returns headers only — there is nothing to parse.

—

Response 400· Bad Request

{
  "message": "<string>",
  "additional_context": {
    "key": "<string>"
  },
  "code": "CLIENT_NOT_FOUND"
}

7 linesCopy

Response 401· Unauthorized

{
  "message": "<string>",
  "additional_context": {
    "key": "<string>"
  },
  "code": "CLIENT_NOT_FOUND"
}

7 linesCopy

Response 502· Bad Gateway

{
  "message": "<string>",
  "additional_context": {
    "key": "<string>"
  },
  "code": "CLIENT_NOT_FOUND"
}

7 linesCopy