Update a PMS provider
PUT
/pms/v1/providers/{id}
Modifies the values of an existing PMS provider.
Only PMS providers created by the authenticated OAuth client can be updated.
Path parameters
-
id integer(int64) Required
Body Required
-
apiKey string Required
Minimum length is
1
, maximum length is255
. -
endpoint string Required
Minimum length is
1
, maximum length is255
. -
features array[string] Required
Values are
SEARCH_BY_NAME
,MIRRORING
,PARTIAL_PAYMENTS
,MULTI_PAYMENTS
, orSERVICE_CHARGE
. -
name string Required
Minimum length is
1
, maximum length is255
.
PUT /pms/v1/providers/{id}
curl \
-X PUT https://api.trial.lsk.lightspeed.app/pms/v1/providers/3012455645 \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"apiKey":"secret-1234","endpoint":"http://integration.com/pms/endpoint","features":["MIRRORING"],"name":"John Smith"}'
Request example
{
"apiKey": "secret-1234",
"endpoint": "http://integration.com/pms/endpoint",
"features": [
"MIRRORING"
],
"name": "John Smith"
}
Response examples (200)
{
"apiKey": "secret-1234",
"businessLocationId": 45454565682155,
"endpoint": "http://integration.com/pms/endpoint",
"features": [
"MIRRORING"
],
"id": 3012455645,
"name": "John Smith"
}