Update Client API

Description

Update the details of a specific client

Security

Logged in user has client API permissions

URL

PATCH  http://exampleserver.com/api/v3/Clients/{client_id}

Parameters        

Model

Field	Type	Description
actualAddress	String (optional)	The client's physical, or street address
postalAddress	String (optional)	The client's postal address
notes	String (optional)	Notes on the client
workPhone	String (optional)	The client's work phone number
workFax	String (optional)	The client's work fax number
workEmail	String (optional)	The client's work email address
mobilePhone	String (optional)	The client's mobile phone number

Example

{                                                                                                                                         

"postalAddress": "string",

"actualAddress": "string",

"notes": "string",

"workPhone": "string",

"workEmail": "string",

"workFax": "string",

"mobilePhone": "string"

}

Response

Model

Field	Type	Description
success	Boolean	True, if the client was successfully updated, false otherwise
errorMessage	String (optional)	True, if the client was successfully updated, false otherwise
clientId	Integer	The client id updated by successful call

Example

{                                                                                                                                         

"success": true,

"errorMessage": "string",

 "clientId": 0 

} 

Error Codes

HTTP Status Code	Type
400	No Content (no records match the search)
403	Forbidden (invalid Authorisation)
404	Dealer not found or Order not found (error will be detailed in response)
503	Service Unavailable (due to maintenance)

Online Documentation

https://api.argos.co.nz/WebApi/swagger/ui/index#!/Clients/Clients_UpdateClient

• Related Articles

• Update Account API

  Description Update the details of a specific account. Security Logged in user has account API permissions URL PATCH http://exampleserver.com/api/v3/Accounts/{account_id} Parameters Model Field Type Description description String (optional) The ...

• Create Client API

  Description Add a new client Security Logged in user has client API permissions URL POST http://example.com/api/clients/createClient Parameters TBC Response Create Client Request Field Type Description code String The client code name String The ...

• Get Client API

  Description Get details for a specific client Security Logged in user has client API permissions URL GET http://exampleserver.com/api/v6/clients/{clientId} Parameters clientId: [Required, part of URL] client to retrieve Response ClientDto Field Type ...

• Installing Argos Internal API

  The Argos Internal API is used to power the Vault and Bailment applications. Note, this is available from Argos v6.0 onwards Installation Types The installer can be used to install a production instance of the Argos Internal API. Instructions to ...

• Argos Vault Release Notes V5.146

  Release Completion Date: 30 August 2024 Please disregard the release notes for the modules you do not use. Unless otherwise indicated, more detail about any change will be included in the relevant dialog [Help] button. Other documents referred to in ...