Update a customer

  • 1 minute(s) read
Prev Next
Put
/network/customers/{customerId}

Required permissions: READ_CUSTOMER, WRITE_CUSTOMER.

Security
HTTP
Type bearer
Header parameters
X-Servitly-Tenant
stringRequired

The name of the target tenant (e.g. acme).

Path parameters
customerId
stringRequired

The customer identifier.

Minimum1.0
Exampleabcd1234
Body parameters

The details of customer being updated.

Expand All
object

The bean providing customer details.

name
string

The name of the customer which could be a personal name or a business name.

country
string

The country the customer belongs to.

timezone
string

The timezone used for date/times localization (e.g. Europe/Rome).

properties
object (Properties)

The set of properties providing additional details to the parent object.

Example{ "foo": "abc", "bar": "123" }
property*
string additionalProperties
creationTimestamp
integer (int64)

The timestamp at which the object was created.

firstAccessTimestamp
integer (int64)

The timestamp at which a client's user first logged in.

lastAccessTimestamp
integer (int64)

The timestamp at which a client's user last logged in.

Responses
200

Successful updated.

Expand All
object

The bean providing customer details.

id
string

The customer object identifier.

name
string

The name of the customer which could be a personal name or a business name.

country
string

The country the customer belongs to.

timezone
string

The timezone used for date/times localization (e.g. Europe/Rome).

properties
object (Properties)

The set of properties providing additional details to the parent object.

Example{ "foo": "abc", "bar": "123" }
property*
string additionalProperties
creationTimestamp
integer (int64)

The timestamp at which the object was created.

firstAccessTimestamp
integer (int64)

The timestamp at which a client's user first logged in.

lastAccessTimestamp
integer (int64)

The timestamp at which a client's user last logged in.

400

Request data not valid.

object
message
string

The error response.

ExampleBad request
401

User not authenticated.

object
message
string

The error response.

ExampleUser not authenticated
403

User not authorized.

object
message
string

The error response.

ExampleUser not authorized
404

Resource was not found.

object
message
string

The error response.

ExampleResource not found
429

API call rate limit exeeded.

object
message
string

The error response.

ExampleAPI call rate limit exeeded
500

Internal server error.

object
message
string

The error response.

ExampleInternal Server Error