PUT | /customers/{customerId}/officers/{id} | Updates an existing Officer entry for this Customer. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CustomerId | path | Guid | Yes | The customer Id. |
Id | path | Guid | Yes | The officer Id. |
Name | body | string | Yes | The label or name of the Officer. |
PhoneNumber | body | string | No | The phone number of the Officer. |
IsDeleted | body | bool | Yes | Whether the Officer is deleted. |
CanAuthorizeRelease | body | bool | No | Whether the Officer can authorize release. |
IsOfficer | body | bool | No | Whether the Officer is a Booting Officer. |
IsEnforcementOfficer | body | bool | No | Whether the Officer is an Enforcement Officer. |
RequiredToLoginForBooting | body | bool | No | Whether the Officer is Required to Login for Booting Operations |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /customers/{customerId}/officers/{id} HTTP/1.1
Host: api.paylock.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"customerId":"00000000000000000000000000000000","id":"00000000000000000000000000000000","name":"String","phoneNumber":"String","isDeleted":false,"canAuthorizeRelease":false,"isOfficer":false,"isEnforcementOfficer":false,"requiredToLoginForBooting":false}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length "00000000000000000000000000000000"