Jump to

• Request
• Response

Create NotificationPreference

post

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

Creates a new Notification Preference for a contact. If the notification preference is for the SMS channel, then the opt in workflow is also triggered.

Request

Supported Media Types

• application/json

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`).
• utilityCode(required): string
  The 3 or 4 digit code for the utility company (e.g. `TEST`).

Header Parameters

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

Body ()

Data used to create the Notification Preference

Root Schema : NotificationPreferenceRequest

Type: object

Show Source

• eventType(required): string
  The name of this type of communication for which there is a notification preference
• notificationChannel(required): string
  Allowed Values: [ "EMAIL", "IVR", "SMS", "PRINT", "PUSH" ]

  The channel over which communications are delivered to a notification contact

{
    "type":"object",
    "properties":{
        "notificationChannel":{
            "type":"string",
            "enum":[
                "EMAIL",
                "IVR",
                "SMS",
                "PRINT",
                "PUSH"
            ],
            "description":"The channel over which communications are delivered to a notification contact"
        },
        "eventType":{
            "type":"string",
            "description":"The name of this type of communication for which there is a notification preference"
        }
    },
    "required":[
        "id",
        "notificationChannel",
        "eventType"
    ],
    "example":{
        "notificationChannel":"EMAIL",
        "eventType":"HOME_ENERGY"
    }
}

Example:

{
    "notificationChannel":"EMAIL",
    "eventType":"HOME_ENERGY"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

The notification preference was created successfully.

Body ()

Root Schema : NotificationPreference

Type: object

Show Source

• response: response

{
    "type":"object",
    "properties":{
        "response":{
            "allOf":[
                {
                    "$ref":"#/definitions/NotificationPreferenceRequest"
                },
                {
                    "type":"object",
                    "properties":{
                        "id":{
                            "type":"integer"
                        }
                    },
                    "example":{
                        "id":1,
                        "notificationChannel":"EMAIL",
                        "eventType":"HOME_ENERGY"
                    }
                }
            ]
        }
    }
}

Nested Schema : response

Match All

Show Source

• object NotificationPreferenceRequest
• object response-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/NotificationPreferenceRequest"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"integer"
                }
            },
            "example":{
                "id":1,
                "notificationChannel":"EMAIL",
                "eventType":"HOME_ENERGY"
            }
        }
    ]
}

Nested Schema : NotificationPreferenceRequest

Type: object

Show Source

• eventType(required): string
  The name of this type of communication for which there is a notification preference
• notificationChannel(required): string
  Allowed Values: [ "EMAIL", "IVR", "SMS", "PRINT", "PUSH" ]

  The channel over which communications are delivered to a notification contact

{
    "type":"object",
    "properties":{
        "notificationChannel":{
            "type":"string",
            "enum":[
                "EMAIL",
                "IVR",
                "SMS",
                "PRINT",
                "PUSH"
            ],
            "description":"The channel over which communications are delivered to a notification contact"
        },
        "eventType":{
            "type":"string",
            "description":"The name of this type of communication for which there is a notification preference"
        }
    },
    "required":[
        "id",
        "notificationChannel",
        "eventType"
    ],
    "example":{
        "notificationChannel":"EMAIL",
        "eventType":"HOME_ENERGY"
    }
}

Example:

{
    "notificationChannel":"EMAIL",
    "eventType":"HOME_ENERGY"
}

Nested Schema : response-allOf[1]

Type: object

Show Source

• id: integer

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer"
        }
    },
    "example":{
        "id":1,
        "notificationChannel":"EMAIL",
        "eventType":"HOME_ENERGY"
    }
}

Example:

{
    "id":1,
    "notificationChannel":"EMAIL",
    "eventType":"HOME_ENERGY"
}

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