Dispute Notification Settings

Retrieving the Tenant's Notification Settings

Swagger Page

https://swagger-ui.aws-prod.billtrust.com/?urls.primaryName=Dispute%20Service%20v1#/DisputeNotificationSettingsV1/get_v1_tenants__tenantId__notification_settings

Permission

Dispute Configuration : READ

Example Request

curl -X GET 'https://arc-aegis.billtrust.com/dispute/v1/tenants/{tenantId}/notification-settings' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'X-Billtrust-Api-Key: <API key value>'

Example Response

{
  "id": "{settingsId}",
  "tenantId": "{tenantId}",
  "allowDailyDigest": true,
  "timeZone": "America/New York",
  "time": "08:00 PM",
  "allowAllUpdates": true,
  "createUser": "{userId}",
  "createDate": "2021-03-28T16:01:34.429Z",
  "updateUser": "{userId}",
  "updateDate": "2021-03-28T16:01:34.429Z"
}

Update the Tenant's Notification Settings

Swagger Page

https://swagger-ui.aws-prod.billtrust.com/?urls.primaryName=Dispute%20Service%20v1#/DisputeNotificationSettingsV1/put_v1_tenants__tenantId__notification_settings

Permission

Dispute Configuration : UPDATE

Example Request

curl -X PUT 'https://arc-aegis.billtrust.com/dispute/v1/tenants/{tenantId}/notification-settings' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'X-Billtrust-Api-Key: <API key value>' \
    -d '{ "allowDailyDigest": true, "timeZone": "America/New York", "time": "08:00 PM", "allowAllUpdates": true }

Example Response

{
  "id": "{settingsId}",
  "tenantId": "{tenantId}",
  "allowDailyDigest": true,
  "timeZone": "America/New York",
  "time": "08:00 PM",
  "allowAllUpdates": true,
  "createUser": "{userId}",
  "createDate": "2021-03-28T16:01:34.429Z",
  "updateUser": "{userId}",
  "updateDate": "2021-03-28T16:01:34.429Z"
}