Update account information by accountId

Request

POST http:///fleet.roadprotect.co.il/api/v1/account/{accountId}

Path parameters

Parameter name Value Description Additional
accountId number Required

Request body

The request body takes a complete UpdateAccountV1Dto resource, containing the following writable properties:

{
    "contactFax": "string",
    "contactName": "string",
    "contactTelephone": "string",
    "documentId": "number",
    "identifier": "string",
    "name": "string",
    "primaryContact": "string",
    "role": "string"
}

Properties

Name Type Description Additional
contactFax string

The fax of the primary contact for this account

Optional
contactName string

The name of the primary contact for this account

Optional
contactTelephone string

The phone of the primary contact for this account

Optional
documentId number

The document id for the power of attorney for this account

Optional
identifier string

The account identifier or BRN

Optional
name string

The name of the group / business / company

Optional
primaryContact string

The email address of the primary contact

Optional
role string

The primary role of the account

Possible values are:

  • Owner
  • User
  • Hybrid
Optional

Authorisation

To authenticate your client integration please put your token in the header of your requests with the key Authorization, it should look like this:

Authorization: Bearer YOUR_TOKEN_HERE

Please keep your token secured. If your token is compromised, we can issue a new token for you.

This request requires the use of one of following authorisation methods: API key .

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
201 Created Account
400 Bad Request

E026: Could not find Account with id: accountId

403 Forbidden

E064: We have disabled the ability to update account BRNs to prevent data corruption. Please contact us so that we can make this change for you if it is intended

500 Internal Server Error

Failed to update account, please contact the developers.