Skip to main content

Input fields

address : String! required

Street address of the new property. Should not contain the postcode.

consentGranularity : String

Consent granularity to set for the provided MPANs of the meter points at the new property (e.g., H, D, M).

moveInDate : String

Date of moving into the new property.

moveInNewProperty : Boolean

If True, this will trigger the move in flow at the new property for the account.

mpans : [String]

MPANs of the electricity meter points at the new property.

mprns : [String]

MPRNs of the gas meter points at the new property.

postcode : String! required

Postcode of new property.

productCode : String

The product to use when creating agreements for the new property. If not provided, the current product for each meter point is used if available, or else the default SVT product. If provided, quote_code must also be provided.

quoteCode : String

A quote that contains the product provided in product_code. Should be provided only if product_code is also provided.Cannot be provided if quote_request_code is also provided.

quoteRequestCode : String

A quote request that contains the product provided in product_code.Should be provided only if product_code is also provided.Cannot be provided if quote_code is also provided.

useDefaultProduct : Boolean

If True, the default product will be selected for the new property. Defaults to False. When False (the default), the current product is ported from the old property.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "address": "authority-sure-poor-community-technology", "consentGranularity": "against-happy-summer-report-exist", "moveInDate": "through-our-tend-throughout-international", "moveInNewProperty": true, "mpans": "put-name-war-sometimes-rise", "mprns": "sport-your-either-cut-section", "postcode": "show-method-main-identify-third", "productCode": "someone-once-always-surface-learn", "quoteCode": "couple-federal-reality-accept-build", "quoteRequestCode": "few-thought-section-wife-myself", "useDefaultProduct": true }