Jump to

• Request
• Response

Update NotificationContact

put

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

Updates an existing Notification Contact. This endpoint returns the same response in both cases when a contact is updated and when the update does not modify the contact. If the update contains a phoneSMS, 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 or update the Notification Contact

Root Schema : NotificationContactRequest

Type: object

Show Source

• email: string
  The email address for the notification contact
• name(required): string
  The name of the notification contact
• phoneSMS: string
  The phone number for the notification contact on the SMS channel
• phoneVoice: string
  The phone number for the notification contact on the IVR channel
• push: boolean
  Whether or not this notification contact can have push notifications sent to them

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the notification contact"
        },
        "email":{
            "type":"string",
            "description":"The email address for the notification contact"
        },
        "phoneSMS":{
            "type":"string",
            "description":"The phone number for the notification contact on the SMS channel"
        },
        "phoneVoice":{
            "type":"string",
            "description":"The phone number for the notification contact on the IVR channel"
        },
        "push":{
            "type":"boolean",
            "description":"Whether or not this notification contact can have push notifications sent to them"
        }
    },
    "required":[
        "name"
    ],
    "example":{
        "name":"Jane Doe",
        "email":"[e-mail]",
        "phoneSMS":"555-123-1234",
        "phoneVoice":"555-123-1234",
        "push":true
    }
}

Example:

{
    "name":"Jane Doe",
    "email":"[e-mail]",
    "phoneSMS":"555-123-1234",
    "phoneVoice":"555-123-1234",
    "push":true
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

The notification contact was updated (or the update had no effect). The returned entity reflects the updated values.

Body ()

Root Schema : NotificationContact

Type: object

Show Source

• response: response

{
    "type":"object",
    "properties":{
        "response":{
            "allOf":[
                {
                    "$ref":"#/definitions/NotificationContactRequest"
                },
                {
                    "type":"object",
                    "properties":{
                        "id":{
                            "type":"integer"
                        },
                        "primary":{
                            "type":"boolean",
                            "description":"Whether or not this notification contact is the primary contact for a customer"
                        }
                    },
                    "required":[
                        "id",
                        "primary"
                    ],
                    "example":{
                        "id":1,
                        "name":"Jane Doe",
                        "email":"[e-mail]",
                        "phoneSMS":"555-123-1234",
                        "phoneVoice":"555-123-1234",
                        "primary":false
                    }
                }
            ]
        }
    }
}

Nested Schema : response

Match All

Show Source

• object NotificationContactRequest
• object response-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/NotificationContactRequest"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"integer"
                },
                "primary":{
                    "type":"boolean",
                    "description":"Whether or not this notification contact is the primary contact for a customer"
                }
            },
            "required":[
                "id",
                "primary"
            ],
            "example":{
                "id":1,
                "name":"Jane Doe",
                "email":"[e-mail]",
                "phoneSMS":"555-123-1234",
                "phoneVoice":"555-123-1234",
                "primary":false
            }
        }
    ]
}

Nested Schema : NotificationContactRequest

Type: object

Show Source

• email: string
  The email address for the notification contact
• name(required): string
  The name of the notification contact
• phoneSMS: string
  The phone number for the notification contact on the SMS channel
• phoneVoice: string
  The phone number for the notification contact on the IVR channel
• push: boolean
  Whether or not this notification contact can have push notifications sent to them

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the notification contact"
        },
        "email":{
            "type":"string",
            "description":"The email address for the notification contact"
        },
        "phoneSMS":{
            "type":"string",
            "description":"The phone number for the notification contact on the SMS channel"
        },
        "phoneVoice":{
            "type":"string",
            "description":"The phone number for the notification contact on the IVR channel"
        },
        "push":{
            "type":"boolean",
            "description":"Whether or not this notification contact can have push notifications sent to them"
        }
    },
    "required":[
        "name"
    ],
    "example":{
        "name":"Jane Doe",
        "email":"[e-mail]",
        "phoneSMS":"555-123-1234",
        "phoneVoice":"555-123-1234",
        "push":true
    }
}

Example:

{
    "name":"Jane Doe",
    "email":"[e-mail]",
    "phoneSMS":"555-123-1234",
    "phoneVoice":"555-123-1234",
    "push":true
}

Nested Schema : response-allOf[1]

Type: object

Show Source

• id(required): integer
• primary(required): boolean
  Whether or not this notification contact is the primary contact for a customer

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer"
        },
        "primary":{
            "type":"boolean",
            "description":"Whether or not this notification contact is the primary contact for a customer"
        }
    },
    "required":[
        "id",
        "primary"
    ],
    "example":{
        "id":1,
        "name":"Jane Doe",
        "email":"[e-mail]",
        "phoneSMS":"555-123-1234",
        "phoneVoice":"555-123-1234",
        "primary":false
    }
}

Example:

{
    "id":1,
    "name":"Jane Doe",
    "email":"[e-mail]",
    "phoneSMS":"555-123-1234",
    "phoneVoice":"555-123-1234",
    "primary":false
}

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