Partly updates a single distributor's details

patch

http://rest.cameramanager.com/rest/v2.0/distributors/{distributorId}/details

(Partly) updates a single distributor's details.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

distributorId

integer

required

ID of the distributor.

Body Params

companyName

string

length ≤ 255

The company's name.

reference

string

length ≤ 255

A small note that can be added by the owner of the distributor

customReference

string

length ≤ 255

A custom note that can be added by the owner of the distributor

string

length ≤ 255

The distributor's contact email address.

active

boolean

The distributor account status. True indicates that the distibutor is active, False indicates that the distributor is inactive.

crmId

string

length ≤ 24

customer identifier used internally by Eagle Eye CameraManager platform

address

string

length ≤ 256

The distributor's address.

zipCode

string

length ≤ 16

The distributor's zip code.

city

string

length ≤ 256

The city where the distributor is located.

country

string

length between 2 and 2

The country where the distributor is located in the ISO 3166-1 alpha-2 format.

firstName

string

length ≤ 256

The first name of the company's contact person.

lastName

string

length ≤ 256

The last name of the company's contact person.

vatNumber

string

length ≤ 32

The distributor's VAT number.

phone

string

length ≤ 255

The distributor's phone number.

website

string

length ≤ 256

The distributor's website.

language

string

length between 2 and 2

The main language used by the distributor in the ISO_639-1 format.

timeZone

string

length ≤ 64

The time zone name the distributor is located in according to the TZ database https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

currency

string

length between 3 and 3

The currency that the distributor should be invoiced for. ISO_4217 format

discountLevel

integer

0 to 100

For a distributor or a reseller of CM distributor, it's the discount percentage that partner has with CM. For a reseller of any other distributor, it's the discount percentage the distributor has given to its reseller.

Responses

204

No content

400The supplied object is invalid. Error detail will contain the validation error.

401You are not authenticated. Please authenticate and try again.

403You have no permission to access the specified resource.

404Referenced resource could not be found.

406The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.

500Something went wrong in the server. Please try again.