1. Documentation
2. API
3. Forms
4. Create

Creating Forms

Create a new Form.

---

HTTP Request

POST https://utilityapi.com/api/v2/forms

Examples

# Create a default authorization form
curl -X POST -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/forms'

# Create a form prefilled with a customer_email and utility
curl -X POST -H 'Authorization: Bearer API_TOKEN_HERE' \
    -d '{"customer_email": "heather.homeowner@yahoo.com", "utility": "LADWP"}' \
    'https://utilityapi.com/api/v2/forms'

# Create a re-authorization Form for an expired Authorization
curl -X POST -H 'Authorization: Bearer API_TOKEN_HERE' \
    -d '{"authorization_uid": "12345"}' \
    'https://utilityapi.com/api/v2/forms'

POST Body

The request body must be a valid JSON object. Below are the possible parameters for the object. If a parameter isn't included the default value is used.

Response

Returns the created Form object.

// Example result
{
    "uid": "12345",
    "created": "2016-01-01T12:30:24.653422+00:00",
    "updated": "2016-01-01T12:30:24.653422+00:00",
    "template_uid": "123423435",
    "authorization_uid": null,
    "url": "https://utilityapi.com/authorize/example_solar?f=097jiosd-8iy5xci23-14fsasaf",
    ...
}

HTTP Response Codes