JSON API » customers » customers/send/lowbalancereminder

Send low balance reminder email to the selected customer, regardless of what its balance actually is.

Input parameters

Requires authentication and the commerce role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
idIntegerID of customer to send the low balance reminder email.Yes

Responses

CodeDescription
204Success.
401The authentication details provided are invalid.
402Your role does not allow this.
404The customer does not exist, or you do not have permission to access its data.

Data returned

No data is returned.

Example: With required parameters

http://enswitch.example.com/api/json/customer/send/lowbalancereminder/?auth_username=user;auth_password=password;id=123

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

VersionChanges
4.4Function added.