Jump to

• Request
• Response

Delete NotificationChannel

delete

/apis/notification-contact-v1/{utilityCode}/customers/{id}/notification_contacts/{contactId}/notification_preferences/channel/{notificationChannel}

Attempts to delete a Notification channel

Request

Path Parameters

• contactId(required): integer
  The single-tenant id for the notification contact (e.g. `2`).
• id(required): integer
  The single-tenant id for the customer (e.g. `1`).
• notificationChannel(required): string
  The notification channel for the preference. Possible values are `EMAIL`, `IVR`, `SMS`, and `PRINT`.
• utilityCode(required): string
  The 3 or 4 digit code for the utility company (e.g. `TEST`).

Query Parameters

• auditAgency: string
  The auditing agency to record for this delete. Possible values are `CUSTOMER`, `OTHER`, and `UNKNOWN`.
• comment: string
  Description of the reasons
• source(required): string
  The (unsubscribe) event source

  Allowed Values: [ "CSR", "EMAIL", "IVR", "SMS", "WEB" ]

Header Parameters

• Authorization(required): string
  The authorization header (e.g. `Authorization: Bearer $YOUR_TOKEN`).

Back to Top

Response

Supported Media Types

• application/json

200 Response

The notification preferences were successfully deleted

Body ()

Root Schema : ChannelUnsubscribeEvent

Type: object

Show Source

• response: object response

{
    "type":"object",
    "properties":{
        "response":{
            "type":"object",
            "properties":{
                "deletedOn":{
                    "type":"string",
                    "format":"date"
                },
                "deletedPreferences":{
                    "type":"integer"
                },
                "email":{
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : response

Type: object

Show Source

• deletedOn: string(date)
• deletedPreferences: integer
• email: string

{
    "type":"object",
    "properties":{
        "deletedOn":{
            "type":"string",
            "format":"date"
        },
        "deletedPreferences":{
            "type":"integer"
        },
        "email":{
            "type":"string"
        }
    }
}

400 Response

An error occurred processing the request. See the response body for more information.

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• details: string
  Details about the error.
• errorMessage: string
  Short failure explanation.
• httpStatus: integer
  Minimum Value: 100

  Maximum Value: 600

  The HTTP status code for the error.
• serviceErrorCode: string
  An error code for the error.

{
    "type":"object",
    "properties":{
        "httpStatus":{
            "description":"The HTTP status code for the error.",
            "type":"integer",
            "minimum":100,
            "maximum":600
        },
        "serviceErrorCode":{
            "description":"An error code for the error.",
            "type":"string"
        },
        "errorMessage":{
            "description":"Short failure explanation.",
            "type":"string"
        },
        "details":{
            "description":"Details about the error.",
            "type":"string"
        }
    },
    "additionalProperties":false
}

401 Response

An error occurred processing the request. See the response body for more information.

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• details: string
  Details about the error.
• errorMessage: string
  Short failure explanation.
• httpStatus: integer
  Minimum Value: 100

  Maximum Value: 600

  The HTTP status code for the error.
• serviceErrorCode: string
  An error code for the error.

{
    "type":"object",
    "properties":{
        "httpStatus":{
            "description":"The HTTP status code for the error.",
            "type":"integer",
            "minimum":100,
            "maximum":600
        },
        "serviceErrorCode":{
            "description":"An error code for the error.",
            "type":"string"
        },
        "errorMessage":{
            "description":"Short failure explanation.",
            "type":"string"
        },
        "details":{
            "description":"Details about the error.",
            "type":"string"
        }
    },
    "additionalProperties":false
}

404 Response

An error occurred processing the request. See the response body for more information.

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• details: string
  Details about the error.
• errorMessage: string
  Short failure explanation.
• httpStatus: integer
  Minimum Value: 100

  Maximum Value: 600

  The HTTP status code for the error.
• serviceErrorCode: string
  An error code for the error.

{
    "type":"object",
    "properties":{
        "httpStatus":{
            "description":"The HTTP status code for the error.",
            "type":"integer",
            "minimum":100,
            "maximum":600
        },
        "serviceErrorCode":{
            "description":"An error code for the error.",
            "type":"string"
        },
        "errorMessage":{
            "description":"Short failure explanation.",
            "type":"string"
        },
        "details":{
            "description":"Details about the error.",
            "type":"string"
        }
    },
    "additionalProperties":false
}

Back to Top