Delete customer group

Deletes a customer group. Set delete_users to keep or remove the associated users.

Path Params
string
required

The ID of the customer group to delete. This is not the UUID.

Query Params
boolean
enum
Defaults to false

Determines whether the users associated with the group are also deleted.

  • false — Deletes the group and preserves all associated user records.
  • true — Deletes the group and permanently removes all associated users.
Allowed:
Responses

400

Bad Request - The request is invalid due to missing or incorrect parameters.

401

Unauthorized - API authentication failed due to an invalid or missing API key.

403

Forbidden - The API key does not have sufficient permissions to perform this action.

404

Not Found - The specified group ID was not found. Verify the value and try again.

429

Too Many Requests - The request limit has been exceeded. Reduce request frequency.

500

Internal Server Error - An unexpected server error occurred. Contact support if the issue persists.

502

Bad Gateway - The server received an invalid response. Retry the request.

503

Service Unavailable - The service is temporarily unavailable. Try again later.

504

Gateway Timeout - The server took too long to respond. Retry the request with exponential backoff.

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json