v1

latestOpenAPI 3.0.02026-07-241010520.6 KB
Projects

Update Project

Update an existing project.

put/tenants/{tenant_id}/projects/{id}

Path parameters

tenant_idstring uuid required

The ID of the tenant that the project is part of.

idstring uuid required

The ID of the project to update.

Request body

Example request

{
  "project": {
    "external_provider_id": "YourId123",
    "name": "My first test project",
    "customer_salutation": "Mrs.",
    "customer_first_name": "Jane",
    "customer_last_name": "Doe",
    "mailing_address": "434 Brannan St, San Francisco, CA, USA",
    "customer_email": "jane@example.com",
    "customer_phone": "(555) 111-5151",
    "status": "Remote Assessment Completed",
    "preferred_solar_modules": [
      "c5565198-91b8-46f1-97e6-db1973b2b4a3"
    ],
    "tags": [
      "third_party_1",
      "region_a"
    ]
  }
}

Response

Project successfully updated.

Example response

{
  "project": {
    "external_provider_id": "YourId123",
    "name": "My first test project",
    "customer_salutation": "Mrs.",
    "customer_first_name": "Jane",
    "customer_last_name": "Doe",
    "mailing_address": "434 Brannan St, San Francisco, CA, USA",
    "customer_email": "jane@example.com",
    "customer_phone": "(555) 111-5151",
    "status": "Remote Assessment Completed",
    "preferred_solar_modules": [
      "c5565198-91b8-46f1-97e6-db1973b2b4a3"
    ],
    "tags": [
      "third_party_1",
      "region_a"
    ],
    "location": {
      "property_address": "434 Brannan St, San Francisco, CA 94107, USA",
      "latitude": 37.77960043,
      "longitude": -122.39530086,
      "property_address_components": {
        "street_address": "434 Brannan St",
        "city": "San Francisco",
        "region": "CA",
        "postal_code": "94107",
        "country": "United States"
      }
    },
    "created_at": "2023-07-11 18:43:18 UTC"
  }
}