--- updatedAt: 2025-06-09T22:28:25.000Z agentTools: projectIndex: https://docs.enerflo.io/llms.txt --- # Update the Details of a Customer # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "enerflo-10-api", "version": "1.0.2" }, "servers": [ { "url": "https://enerflo.io/api/" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "header", "name": "api-key" } } }, "security": [ { "sec0": [] } ], "paths": { "/v3/customers/{id}": { "put": { "summary": "Update the Details of a Customer", "description": "", "operationId": "update-the-details-of-a-customer", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the customer. ex: https://enerflo.io/customer/edit/2445615", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "office_id": { "type": "integer", "description": "The Office ID is found in the URL of an office page. ex: https://enerflo.io/company/office/edit/3913", "format": "int32" }, "agent_user_id": { "type": "integer", "description": "This is the Enerflo User ID of the Sales Rep.", "format": "int32" }, "setter_user_id": { "type": "integer", "description": "This field specifies the ID of the Enerflo user who will be assigned as the lead's setter", "format": "int32" }, "creator_user_id": { "type": "integer", "description": "The ID of the Enerflo user that is authoring/creating the lead record.", "format": "int32" }, "first_name": { "type": "string", "description": "The customer's first name" }, "last_name": { "type": "string", "description": "The customer's last name" }, "secondary_first_name": { "type": "string", "description": "The secondary customer's first name" }, "secondary_last_name": { "type": "string", "description": "The secondary customer's last name" }, "email": { "type": "string", "description": "The customer's email address" }, "secondary_email": { "type": "string", "description": "The secondary customer's email address" }, "mobile": { "type": "string", "description": "The mobile phone number of the lead, used for SMS notifications and messaging." }, "secondary_mobile": { "type": "string", "description": "The secondary customer's mobile phone number" }, "lead_source": { "type": "string", "description": "The source of the lead, most often for marketing services. Valid values can be found here: https://enerflo.io/company/leadsources" }, "status_id": { "type": "integer", "description": "An initial lead status. Does not need to match a company-specific Enerflo lead status. https://enerflo.io/company/statuses", "format": "int32" }, "sms_opt_in": { "type": "boolean", "description": "Indicates whether the customer has opted in to receive SMS communications. Customers must explicitly opt-in (verbally to a sales rep or digitally) before any SMS messages can be sent. This is required to maintain compliance with FCC, TCPA, and CTIA regulations. If not provided, the default value is false and no messages will be delivered. This value can be updated via the API or UI unless the customer has explicitly replied \"STOP\" to an SMS. In that case, they cannot be opted in unless they text \"START\"." } } } }, "multipart/form-data": { "schema": { "type": "object", "properties": { "office_id": { "type": "integer", "description": "The Office ID is found in the URL of an office page. ex: https://enerflo.io/company/office/edit/3913", "format": "int32" }, "agent_user_id": { "type": "integer", "description": "This is the Enerflo User ID of the Sales Rep.", "format": "int32" }, "setter_user_id": { "type": "integer", "description": "This field specifies the ID of the Enerflo user who will be assigned as the lead's setter", "format": "int32" }, "creator_user_id": { "type": "integer", "description": "The ID of the Enerflo user that is authoring/creating the lead record.", "format": "int32" }, "first_name": { "type": "string", "description": "The customer's first name" }, "last_name": { "type": "string", "description": "The customer's last name" }, "secondary_first_name": { "type": "string", "description": "The secondary customer's first name" }, "secondary_last_name": { "type": "string", "description": "The secondary customer's last name" }, "email": { "type": "string", "description": "The customer's email address" }, "secondary_email": { "type": "string", "description": "The secondary customer's email address" }, "mobile": { "type": "string", "description": "The mobile phone number of the lead, used for SMS notifications and messaging." }, "secondary_mobile": { "type": "string", "description": "The secondary customer's mobile phone number" }, "lead_source": { "type": "string", "description": "The source of the lead, most often for marketing services. Valid values can be found here: https://enerflo.io/company/leadsources" }, "status_id": { "type": "integer", "description": "An initial lead status. Does not need to match a company-specific Enerflo lead status. https://enerflo.io/company/statuses", "format": "int32" }, "sms_opt_in": { "type": "boolean", "description": "Indicates whether the customer has opted in to receive SMS communications. If not provided, the default value is false. This value can be updated via the API or UI unless the customer has explicitly replied \"STOP\" to an SMS. In that case, they cannot be opted in unless they text \"START\"." } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": 2445615,\n \"created_at\": \"2024-04-02T20:07:52+00:00\",\n \"company_id\": 2778,\n \"office_id\": 3913,\n \"agent_user_id\": 80831,\n \"setter_user_id\": 84787,\n \"creator_user_id\": 72504,\n \"name\": \"Add Customertest\",\n \"first_name\": \"Add\",\n \"last_name\": \"Customertest\",\n \"secondary_name\": \"\",\n \"secondary_first_name\": null,\n \"secondary_last_name\": null,\n \"email\": \"tessssssssst@gmail.com\",\n \"secondary_email\": null,\n \"phone\": \"0000000001\",\n \"secondary_phone\": null,\n \"address\": \"6506 Alabaster Dr\",\n \"unit_number\": null,\n \"city\": \"Killeen\",\n \"state\": \"TX\",\n \"zip\": \"76542\",\n \"status\": \"Set\",\n \"lead_source\": \"gtr\",\n \"language\": \"en_US\",\n \"lat\": 31.047127,\n \"lng\": -97.6757101,\n \"details\": null,\n \"external_id\": null,\n \"integration_maps\": [\n {\n \"id\": 2744227,\n \"integration_type\": \"Partner\",\n \"integration_record_type\": \"Lead\",\n \"external_id\": \"testlead987238\"\n },\n {\n \"id\": 2746494,\n \"integration_type\": \"Enerflo V2\",\n \"integration_record_type\": \"EnerfloV2Customer\",\n \"external_id\": \"a6d84dc3-3267-4ea6-9492-d246cb0bcca9\"\n }\n ],\n \"deals\": [\n {\n \"DealName\": \"Sakevych Solar Master Deal V2\",\n \"DealStarted\": \"04/03/24\",\n \"EnerfloV1DealId\": 2102993,\n \"EnerfloV2DealId\": \"6f2cc335a70d9f1106efc068b569dc49\"\n }\n ],\n \"customer_portal_url\": \"https://enerflo.io/us/haeYnv\",\n \"customer_portal_id\": 2014517,\n \"stream_channel_id\": \"cp-8b8ebfba-5800-416b-884f-99184478b53d\",\n \"tasks\": [],\n \"first_contact\": \"04/05/24\",\n \"last_contact\": \"04/05/24\",\n \"lender\": \"N/A\",\n \"application_status\": \"N/A\",\n \"application_date\": \"N/A\"\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 2445615, "default": 0 }, "created_at": { "type": "string", "example": "2024-04-02T20:07:52+00:00" }, "company_id": { "type": "integer", "example": 2778, "default": 0 }, "office_id": { "type": "integer", "example": 3913, "default": 0 }, "agent_user_id": { "type": "integer", "example": 80831, "default": 0 }, "setter_user_id": { "type": "integer", "example": 84787, "default": 0 }, "creator_user_id": { "type": "integer", "example": 72504, "default": 0 }, "name": { "type": "string", "example": "Add Customertest" }, "first_name": { "type": "string", "example": "Add" }, "last_name": { "type": "string", "example": "Customertest" }, "secondary_name": { "type": "string", "example": "" }, "secondary_first_name": {}, "secondary_last_name": {}, "email": { "type": "string", "example": "tessssssssst@gmail.com" }, "secondary_email": {}, "phone": { "type": "string", "example": "0000000001" }, "secondary_phone": {}, "address": { "type": "string", "example": "6506 Alabaster Dr" }, "unit_number": {}, "city": { "type": "string", "example": "Killeen" }, "state": { "type": "string", "example": "TX" }, "zip": { "type": "string", "example": "76542" }, "status": { "type": "string", "example": "Set" }, "lead_source": { "type": "string", "example": "gtr" }, "language": { "type": "string", "example": "en_US" }, "lat": { "type": "number", "example": 31.047127, "default": 0 }, "lng": { "type": "number", "example": -97.6757101, "default": 0 }, "details": {}, "external_id": {}, "integration_maps": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 2744227, "default": 0 }, "integration_type": { "type": "string", "example": "Partner" }, "integration_record_type": { "type": "string", "example": "Lead" }, "external_id": { "type": "string", "example": "testlead987238" } } } }, "deals": { "type": "array", "items": { "type": "object", "properties": { "DealName": { "type": "string", "example": "Sakevych Solar Master Deal V2" }, "DealStarted": { "type": "string", "example": "04/03/24" }, "EnerfloV1DealId": { "type": "integer", "example": 2102993, "default": 0 }, "EnerfloV2DealId": { "type": "string", "example": "6f2cc335a70d9f1106efc068b569dc49" } } } }, "customer_portal_url": { "type": "string", "example": "https://enerflo.io/us/haeYnv" }, "customer_portal_id": { "type": "integer", "example": 2014517, "default": 0 }, "stream_channel_id": { "type": "string", "example": "cp-8b8ebfba-5800-416b-884f-99184478b53d" }, "tasks": { "type": "array" }, "first_contact": { "type": "string", "example": "04/05/24" }, "last_contact": { "type": "string", "example": "04/05/24" }, "lender": { "type": "string", "example": "N/A" }, "application_status": { "type": "string", "example": "N/A" }, "application_date": { "type": "string", "example": "N/A" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Not Found\"\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Not Found" } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```