Skip to main content

Input fields

accountNumber : String! required

The account number associated with the property.

addressLine1 : String! required

The first line of the address.

addressLine2 : String! required

The second line of the address.

addressLine3 : String

The third line of the address.

autoTopUpPaymentAmount : Int

Amount (in cents) to pay when account balance falls low Used for pre-pay agreements.

city : String! required

The city of the address.

effectiveFrom : DateTime

Date at which the move in/switch request should be initiated.

The type of enrollment request.

esiId : String! required

The ESI ID of the property.

hasCriticalCare : Boolean

Indicates if the property has critical care needs.

postcode : String! required

The postcode of the address.

productId : String

Product ID for the enrollment.

quoteCode : String

Quote code.

setupAutopay : Boolean default: True

Should the agreement created be configured for auto-pay.

state : String! required

The state of the address.

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

{ "accountNumber": "A-EB27A7EC", "addressLine1": "often-air-win-drug-employee", "addressLine2": "common-chance-customer-find-serious", "addressLine3": "strategy-land-technology-talk-collection", "autoTopUpPaymentAmount": 46, "city": "make-talk-shoulder-now-himself", "effectiveFrom": "1986-01-28T12:23:04.742993+00:00", "enrollmentType": "PENDING_MOVE_IN_REQUEST", "esiId": "24514198", "hasCriticalCare": true, "postcode": "tough-agency-notice-actually-fast", "productId": "97158881", "quoteCode": "carry-matter-occur-find-me", "setupAutopay": true, "state": "ground-more-a-kind-last" }