Integration
WIP: A summary needs to be written for Integration
DELETE/v3/integration/payment/manual/:id
Delete Payment
Delete manual payment
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the object
200
Response
- Name
data
- Type
- object
- Description
- Name
success
- Type
- boolean Required
- Description
Properties for data
object
- Name
id
- Type
- string Required
- Description
- the id for the object
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- The error message
- Name
success
- Type
- boolean Required
- Description
- Returns false to indicate the request failed
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- The error message
- Name
success
- Type
- boolean Required
- Description
- Returns false to indicate the request failed
Example Requestapplication/json
DELETE
/v3/integration/payment/manual/:idcurl https://api.shopmonkey.cloud/v3/integration/payment/manual/ID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X DELETE -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true
}
POST/v3/integration/payment/manual/charge
Record Payment
Records a payment manually
Body parameters
200
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
- Name
data
- Type
- object Required
- Description
- Payment schema
Properties for data
object
- Name
id
- Type
- string Required
- Description
- Name
createdDate
- Type
- string Required
- Description
- Name
updatedDate
- Type
- string Required
- Description
- Name
companyId
- Type
- string Required
- Description
- Name
locationId
- Type
- string Required
- Description
- Name
orderId
- Type
- string Required
- Description
- Name
payerId
- Type
- string Required
- Description
- Name
statementId
- Type
- string Required
- Description
- Name
recordedDate
- Type
- string Required
- Description
- the date that the payment was recorded
- Name
note
- Type
- string Required
- Description
- Name
userData
- Type
- object
- Description
- Name
status
- Type
- string Required
- Description
- Name
paymentType
- Type
- string Required
- Description
- Name
paymentMode
- Type
- string Required
- Description
- Name
transactionType
- Type
- string Required
- Description
- Name
amountCents
- Type
- integer Required
- Description
- amount charged or refuned
- Name
refundedAmountCents
- Type
- integer Required
- Description
- amount refunded for charge transactions
- Name
refunded
- Type
- boolean Required
- Description
- Name
refundReason
- Type
- string Required
- Description
- Name
chargeId
- Type
- string Required
- Description
- reference for original payment if transaction type is different from charge
- Name
deposit
- Type
- boolean Required
- Description
- Name
checkNumber
- Type
- string Required
- Description
- Name
cardType
- Type
- string Required
- Description
- Name
cardDigits
- Type
- string Required
- Description
- Name
cardName
- Type
- string Required
- Description
- Name
cardConfirmation
- Type
- string Required
- Description
- Name
debitCard
- Type
- boolean Required
- Description
- Name
chargeFromPublicPage
- Type
- boolean Required
- Description
- Name
payoutId
- Type
- string Required
- Description
- Name
provider
- Type
- string Required
- Description
- Name
providerData
- Type
- object
- Description
- Name
receiptNumber
- Type
- integer Required
- Description
- Name
providerFee
- Type
- integer Required
- Description
- SM payments fee amount in cents on top of Stripe fee
- Name
transactionalFeeAmountCents
- Type
- integer Required
- Description
- amount charged as SM transactional fee (service fee)
- Name
disputedPaymentId
- Type
- string Required
- Description
- if a payment is a deduction/correction of a disputed payment, here we store link to that original disputed payment
- Name
disputedStatus
- Type
- string Required
- Description
- Name
disputedReason
- Type
- string Required
- Description
- Name
disputedType
- Type
- string Required
- Description
- Name
bulkPaymentId
- Type
- string Required
- Description
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Requestapplication/json
POST
/v3/integration/payment/manual/chargecurl https://api.shopmonkey.cloud/v3/integration/payment/manual/charge \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X POST -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"payerId": null,
"statementId": null,
"recordedDate": null,
"note": "note",
"status": "status",
"paymentType": "paymentType",
"paymentMode": "paymentMode",
"transactionType": "transactionType",
"amountCents": 1,
"refundedAmountCents": null,
"refunded": true,
"refundReason": null,
"chargeId": null,
"deposit": true,
"checkNumber": null,
"cardType": null,
"cardDigits": null,
"cardName": null,
"cardConfirmation": null,
"debitCard": true,
"chargeFromPublicPage": true,
"provider": null,
"receiptNumber": 1,
"providerFee": null,
"transactionalFeeAmountCents": null,
"disputedPaymentId": null,
"disputedStatus": null,
"disputedReason": null,
"disputedType": null,
"bulkPaymentId": null
}
}
POST/v3/integration/payment/manual/charge/bulk
Record Bulk Payment
Records a bulk payment manually
Body parameters
200
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
- Name
data
- Type
- array Required
- Description
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Requestapplication/json
POST
/v3/integration/payment/manual/charge/bulkcurl https://api.shopmonkey.cloud/v3/integration/payment/manual/charge/bulk \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X POST -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"payerId": null,
"statementId": null,
"recordedDate": null,
"note": "note",
"status": "status",
"paymentType": "paymentType",
"paymentMode": "paymentMode",
"transactionType": "transactionType",
"amountCents": 1,
"refundedAmountCents": null,
"refunded": true,
"refundReason": null,
"chargeId": null,
"deposit": true,
"checkNumber": null,
"cardType": null,
"cardDigits": null,
"cardName": null,
"cardConfirmation": null,
"debitCard": true,
"chargeFromPublicPage": true,
"payoutId": null,
"provider": null,
"receiptNumber": 1,
"providerFee": null,
"transactionalFeeAmountCents": null,
"disputedPaymentId": null,
"disputedStatus": null,
"disputedReason": null,
"disputedType": null,
"bulkPaymentId": null
}
]
}
PUT/v3/integration/payment/manual/charge/bulk/:id
Update Bulk Payment
Update a bulk payment manually
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the object
Body parameters
- Name
locationId
- Type
- string
- Description
- Name
payerId
- Type
- string
- Description
- Name
statementId
- Type
- string
- Description
- Name
recordedDate
- Type
- string
- Description
- the date that the payment was recorded
- Name
note
- Type
- string
- Description
- Name
userData
- Type
- object
- Description
- Name
status
- Type
- string
- Description
- Name
paymentType
- Type
- string
- Description
- Name
paymentMode
- Type
- string
- Description
- Name
transactionType
- Type
- string
- Description
- Name
refundedAmountCents
- Type
- integer
- Description
- amount refunded for charge transactions
- Name
refundReason
- Type
- string
- Description
- Name
chargeId
- Type
- string
- Description
- reference for original payment if transaction type is different from charge
- Name
deposit
- Type
- boolean
- Description
- Name
checkNumber
- Type
- string
- Description
- Name
cardType
- Type
- string
- Description
- Name
cardDigits
- Type
- string
- Description
- Name
cardName
- Type
- string
- Description
- Name
cardConfirmation
- Type
- string
- Description
- Name
debitCard
- Type
- boolean
- Description
- Name
chargeFromPublicPage
- Type
- boolean
- Description
- Name
payoutId
- Type
- string
- Description
- Name
provider
- Type
- string
- Description
- Name
providerData
- Type
- object
- Description
- Name
receiptNumber
- Type
- integer
- Description
- Name
providerFee
- Type
- integer
- Description
- SM payments fee amount in cents on top of Stripe fee
- Name
transactionalFeeAmountCents
- Type
- integer
- Description
- amount charged as SM transactional fee (service fee)
- Name
disputedPaymentId
- Type
- string
- Description
- if a payment is a deduction/correction of a disputed payment, here we store link to that original disputed payment
- Name
disputedStatus
- Type
- string
- Description
- Name
disputedReason
- Type
- string
- Description
- Name
disputedType
- Type
- string
- Description
- Name
bulkPaymentId
- Type
- string
- Description
- Name
orders
- Type
- array
- Description
200
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
- Name
data
- Type
- array Required
- Description
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Requestapplication/json
PUT
/v3/integration/payment/manual/charge/bulk/:idcurl https://api.shopmonkey.cloud/v3/integration/payment/manual/charge/bulk/ID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PUT -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"payerId": null,
"statementId": null,
"recordedDate": null,
"note": "note",
"status": "status",
"paymentType": "paymentType",
"paymentMode": "paymentMode",
"transactionType": "transactionType",
"amountCents": 1,
"refundedAmountCents": null,
"refunded": true,
"refundReason": null,
"chargeId": null,
"deposit": true,
"checkNumber": null,
"cardType": null,
"cardDigits": null,
"cardName": null,
"cardConfirmation": null,
"debitCard": true,
"chargeFromPublicPage": true,
"payoutId": null,
"provider": null,
"receiptNumber": 1,
"providerFee": null,
"transactionalFeeAmountCents": null,
"disputedPaymentId": null,
"disputedStatus": null,
"disputedReason": null,
"disputedType": null,
"bulkPaymentId": null
}
]
}
DELETE/v3/integration/payment/manual/charge/bulk/:id
Delete Bulk Payment
Delete a bulk payment manually
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the object
200
Response
- Name
data
- Type
- object Required
- Description
- Name
success
- Type
- boolean Required
- Description
Properties for data
object
- Name
bulkPaymentId
- Type
- string
- Description
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- The error message
- Name
success
- Type
- boolean Required
- Description
- Returns false to indicate the request failed
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- The error message
- Name
success
- Type
- boolean Required
- Description
- Returns false to indicate the request failed
Example Requestapplication/json
DELETE
/v3/integration/payment/manual/charge/bulk/:idcurl https://api.shopmonkey.cloud/v3/integration/payment/manual/charge/bulk/ID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X DELETE -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"data": {
"bulkPaymentId": "bulkPaymentId"
},
"success": true
}
POST/v3/integration/payment/manual/refund
Create
Create an
Body parameters
- Name
chargeId
- Type
- string Required
- Description
- The payment id to refund
- Name
recordedDate
- Type
- string Required
- Description
- the date that the payment was recorded
- Name
paymentType
- Type
- string Required
- Description
- Name
amountCents
- Type
- integer Required
- Description
- amount charged or refuned
- Name
refundReason
- Type
- string Required
- Description
- Name
note
- Type
- string
- Description
200
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
- Name
data
- Type
- object Required
- Description
- Payment schema
Properties for data
object
- Name
id
- Type
- string Required
- Description
- Name
createdDate
- Type
- string Required
- Description
- Name
updatedDate
- Type
- string Required
- Description
- Name
companyId
- Type
- string Required
- Description
- Name
locationId
- Type
- string Required
- Description
- Name
orderId
- Type
- string Required
- Description
- Name
payerId
- Type
- string Required
- Description
- Name
statementId
- Type
- string Required
- Description
- Name
recordedDate
- Type
- string Required
- Description
- the date that the payment was recorded
- Name
note
- Type
- string Required
- Description
- Name
userData
- Type
- object
- Description
- Name
status
- Type
- string Required
- Description
- Name
paymentType
- Type
- string Required
- Description
- Name
paymentMode
- Type
- string Required
- Description
- Name
transactionType
- Type
- string Required
- Description
- Name
amountCents
- Type
- integer Required
- Description
- amount charged or refuned
- Name
refundedAmountCents
- Type
- integer Required
- Description
- amount refunded for charge transactions
- Name
refunded
- Type
- boolean Required
- Description
- Name
refundReason
- Type
- string Required
- Description
- Name
chargeId
- Type
- string Required
- Description
- reference for original payment if transaction type is different from charge
- Name
deposit
- Type
- boolean Required
- Description
- Name
checkNumber
- Type
- string Required
- Description
- Name
cardType
- Type
- string Required
- Description
- Name
cardDigits
- Type
- string Required
- Description
- Name
cardName
- Type
- string Required
- Description
- Name
cardConfirmation
- Type
- string Required
- Description
- Name
debitCard
- Type
- boolean Required
- Description
- Name
chargeFromPublicPage
- Type
- boolean Required
- Description
- Name
payoutId
- Type
- string Required
- Description
- Name
provider
- Type
- string Required
- Description
- Name
providerData
- Type
- object
- Description
- Name
receiptNumber
- Type
- integer Required
- Description
- Name
providerFee
- Type
- integer Required
- Description
- SM payments fee amount in cents on top of Stripe fee
- Name
transactionalFeeAmountCents
- Type
- integer Required
- Description
- amount charged as SM transactional fee (service fee)
- Name
disputedPaymentId
- Type
- string Required
- Description
- if a payment is a deduction/correction of a disputed payment, here we store link to that original disputed payment
- Name
disputedStatus
- Type
- string Required
- Description
- Name
disputedReason
- Type
- string Required
- Description
- Name
disputedType
- Type
- string Required
- Description
- Name
bulkPaymentId
- Type
- string Required
- Description
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Requestapplication/json
POST
/v3/integration/payment/manual/refundcurl https://api.shopmonkey.cloud/v3/integration/payment/manual/refund \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X POST -H 'Content-Type: application/json' \
--data '{ "chargeId" : "value", "recordedDate" : "value", "paymentType" : "value", "amountCents" : 0, "refundReason" : "value" }'
Example Responseapplication/json
{
"success": true,
"data": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"orderId": "orderId",
"payerId": null,
"statementId": null,
"recordedDate": null,
"note": "note",
"status": "status",
"paymentType": "paymentType",
"paymentMode": "paymentMode",
"transactionType": "transactionType",
"amountCents": 1,
"refundedAmountCents": null,
"refunded": true,
"refundReason": null,
"chargeId": null,
"deposit": true,
"checkNumber": null,
"cardType": null,
"cardDigits": null,
"cardName": null,
"cardConfirmation": null,
"debitCard": true,
"chargeFromPublicPage": true,
"provider": null,
"receiptNumber": 1,
"providerFee": null,
"transactionalFeeAmountCents": null,
"disputedPaymentId": null,
"disputedStatus": null,
"disputedReason": null,
"disputedType": null,
"bulkPaymentId": null
}
}
GET/v3/integration/phone/settings/:locationId
Find phone number settings by location
Find phone number settings by location
URL parameters
- Name
locationId
- Type
- string Required
- Description
- the location identifier
200
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
- Name
data
- Type
- object Required
- Description
- LocationPhoneNumber schema
Properties for data
object
- Name
id
- Type
- string Required
- Description
- Name
createdDate
- Type
- string Required
- Description
- Name
updatedDate
- Type
- string Required
- Description
- Name
companyId
- Type
- string Required
- Description
- Name
locationId
- Type
- string Required
- Description
- Name
phoneNumber
- Type
- string Required
- Description
- Name
voiceForwardingNumber
- Type
- string Required
- Description
- Voice call forwarding number
- Name
tcrCampaignId
- Type
- string Required
- Description
- Internal field for campaign ID (Campaign Registry)
- Name
status
- Type
- string Required
- Description
- Name
configurationCurrentState
- Type
- string Required
- Description
- Name
error
- Type
- string Required
- Description
- Internal field for error tracking
- Name
smsUsageAgreementAcceptedById
- Type
- string Required
- Description
- ID of user who accepted Shopmonkey's Usage Agreement
- Name
smsUsageAgreementAcceptedDate
- Type
- string Required
- Description
- DateTime when Shopmonkey's Usage Agreement was accepted
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Request
GET
/v3/integration/phone/settings/:locationIdcurl https://api.shopmonkey.cloud/v3/integration/phone/settings/LOCATIONID \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"success": true,
"data": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"phoneNumber": "phoneNumber",
"voiceForwardingNumber": null,
"status": "status",
"error": null
}
}
PUT/v3/integration/phone/settings/:locationId
Update phone number settings by location
Update phone number settings by location
URL parameters
- Name
locationId
- Type
- string Required
- Description
- the location identifier
Body parameters
- Name
voiceForwardingNumber
- Type
- string Required
- Description
- Voice call forwarding number
200
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
- Name
data
- Type
- object Required
- Description
- LocationPhoneNumber schema
Properties for data
object
- Name
id
- Type
- string Required
- Description
- Name
createdDate
- Type
- string Required
- Description
- Name
updatedDate
- Type
- string Required
- Description
- Name
companyId
- Type
- string Required
- Description
- Name
locationId
- Type
- string Required
- Description
- Name
phoneNumber
- Type
- string Required
- Description
- Name
voiceForwardingNumber
- Type
- string Required
- Description
- Voice call forwarding number
- Name
tcrCampaignId
- Type
- string Required
- Description
- Internal field for campaign ID (Campaign Registry)
- Name
status
- Type
- string Required
- Description
- Name
configurationCurrentState
- Type
- string Required
- Description
- Name
error
- Type
- string Required
- Description
- Internal field for error tracking
- Name
smsUsageAgreementAcceptedById
- Type
- string Required
- Description
- ID of user who accepted Shopmonkey's Usage Agreement
- Name
smsUsageAgreementAcceptedDate
- Type
- string Required
- Description
- DateTime when Shopmonkey's Usage Agreement was accepted
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Requestapplication/json
PUT
/v3/integration/phone/settings/:locationIdcurl https://api.shopmonkey.cloud/v3/integration/phone/settings/LOCATIONID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PUT -H 'Content-Type: application/json' \
--data '{ "voiceForwardingNumber" : "value" }'
Example Responseapplication/json
{
"success": true,
"data": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"locationId": "locationId",
"phoneNumber": "phoneNumber",
"voiceForwardingNumber": null,
"status": "status",
"error": null
}
}