Skip to main content

Update Customer Settings

Updates the current customer settings of the project

HTTP Request​

PATCH/api/settings/customers

Authorization​

Authorization

  • Required: Yes
  • Permission: Staff with CustomersSettingsPermission or Admin
  • Permission Code: 1017
  • Authentication: Token authentication

Request Body​

FieldTypeRequiredDescription
customers_default_customer_statusBooleanNoDefault status for new customers (active or not, default: false)

Example Requests​

1# Update customer settings
2response = requests.patch('http://www.example.com/api/settings/customers', 
3  json={
4      'customers_default_customer_status': True,
5  },
6  headers={'Authorization': 'Token <your_api_key>'}
7)
8print(response.json())

Response Fields​

FieldTypeDescription
customers_default_customer_statusBooleanDefault status for new customers (default: false)

Example Response​

{
"customers_default_customer_status": true
}