Update a PMS provider
Modifies the values of an existing PMS provider.
Only PMS providers created by the authenticated OAuth client can be updated.
Body Required
-
Minimum length is
1
, maximum length is255
. -
Minimum length is
1
, maximum length is255
. -
Minimum length is
1
, maximum length is255
. -
Values are
SEARCH_BY_NAME
,MIRRORING
,PARTIAL_PAYMENTS
,MULTI_PAYMENTS
,SERVICE_CHARGE
, orENRICHED_PAYLOAD
.
PUT /pms/v1/providers/{id}
curl \
-X PUT https://api.lsk.lightspeed.app/pms/v1/providers/3012455645 \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"John Smith","endpoint":"http://integration.com/pms/endpoint","apiKey":"secret-1234","features":["MIRRORING"]}'
Request examples
{
"name": "John Smith",
"endpoint": "http://integration.com/pms/endpoint",
"apiKey": "secret-1234",
"features": [
"MIRRORING"
]
}
Response examples (200)
{
"id": 3012455645,
"businessLocationId": 45454565682155,
"name": "John Smith",
"endpoint": "http://integration.com/pms/endpoint",
"apiKey": "secret-1234",
"features": [
"MIRRORING"
]
}
Response examples (400)
{"status"=>"string", "timestamp"=>"2024-05-04T09:42:00+00:00", "message"=>"string", "apiSubExceptions"=>[{"field"=>"string", "rejectedValue"=>{}, "message"=>"string"}]}
Response examples (403)
{"status"=>"string", "timestamp"=>"2024-05-04T09:42:00+00:00", "message"=>"string", "apiSubExceptions"=>[{"field"=>"string", "rejectedValue"=>{}, "message"=>"string"}]}
Response examples (404)
{"status"=>"string", "timestamp"=>"2024-05-04T09:42:00+00:00", "message"=>"string", "apiSubExceptions"=>[{"field"=>"string", "rejectedValue"=>{}, "message"=>"string"}]}
Response examples (503)
{"status"=>"string", "timestamp"=>"2024-05-04T09:42:00+00:00", "message"=>"string", "apiSubExceptions"=>[{"field"=>"string", "rejectedValue"=>{}, "message"=>"string"}]}