Create an invitation that lets a contributor update credentials on an existing utility account connection. The response includes an invitationUrl to send to the contributor.
Connections that were created by recipients of this invitation. Only populated for CREATE_CONNECTION invitations; empty list for EDIT_CONNECTION.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Nectar Knowledge Base","colors":{"primary":"#092A54","light":"#3B82F6","dark":"#092A54"},"logo":{"light":"https://mintcdn.com/nectar/XTv6xdiQoWsCyg3G/logo/light.svg?fit=max\u0026auto=format\u0026n=XTv6xdiQoWsCyg3G\u0026q=85\u0026s=8b28e329f1aad1d1fbf3022d179cd34e","dark":"https://mintcdn.com/nectar/XTv6xdiQoWsCyg3G/logo/dark.svg?fit=max\u0026auto=format\u0026n=XTv6xdiQoWsCyg3G\u0026q=85\u0026s=12755083e4efe9b6e55b2f5bd4a71673"},"favicon":"https://mintcdn.com/nectar/XTv6xdiQoWsCyg3G/favicon.svg?fit=max\u0026auto=format\u0026n=XTv6xdiQoWsCyg3G\u0026q=85\u0026s=0442a8655f01c969dbb6dfb7a187d797","navbar":{"links":[{"href":"mailto:support@nectarclimate.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://dash.nectarclimate.com"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/nectarclimate"}},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Dashboard","icon":"gauge","href":"https://dash.nectarclimate.com"},{"anchor":"Support","icon":"envelope","href":"mailto:support@nectarclimate.com"},{"anchor":"Status","icon":"signal","href":"https://stats.uptimerobot.com/rICwZ0oMLI"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"nectar","hasAudioNarration":false,"actualSubdomain":"nectar","customDomains":["nectarclimate.com"],"gitSource":{"type":"github","owner":"project-pairly","repo":"nectar","deployBranch":"production","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad6d384536dd68dd9ccfac8","collectionId":"ff45001c-a2bb-4acf-a3b6-e7a83bf9339a","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad6d384536dd68dd9ccfac8"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adff6624c95040b1f492aac","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"API Reference","count":191},{"language":"default","tag":"Knowledge Base","count":153},{"language":"default","tag":"Data Input","count":58},{"language":"default","tag":"Utility-Specific MFA Guides","count":44},{"language":"default","tag":"Connections","count":27},{"language":"default","tag":"Usage Data","count":24},{"language":"default","tag":"Webhook Payloads","count":24},{"language":"default","tag":"Developer Guide","count":18},{"language":"default","tag":"Sites","count":18},{"language":"default","tag":"Meters","count":18}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/v2-0/invitations/create-reconnect-invitation","slug":"/api-reference/v2-0/invitations/create-reconnect-invitation","pageMetadata":{"title":"Create Reconnect Invitation","description":"Create an invitation that lets a contributor update credentials on an existing utility account connection. The response includes an `invitationUrl` to send to the contributor.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json post /invitation/connection/{connection_id}","href":"/api-reference/v2-0/invitations/create-reconnect-invitation","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Create an invitation that lets a contributor update credentials on an existing utility account connection. The response includes an \", _jsx(_components.code, {\n children: \"invitationUrl\"\n }), \" to send to the contributor.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create Reconnect Invitation","description":"Create an invitation that lets a contributor update credentials on an existing utility account connection. The response includes an `invitationUrl` to send to the contributor.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json post /invitation/connection/{connection_id}","href":"/api-reference/v2-0/invitations/create-reconnect-invitation","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"invitation_connection_create","description":"Create an invitation that lets a contributor update credentials on an existing utility account connection. The response includes an `invitationUrl` to send to the contributor.","summary":"Create Reconnect Invitation","parameters":["c17c0833-e28c-46b7-8688-04a1d9d4ba2e"],"tags":["Invitations"],"requestBody":"b0a95d34-f726-4cf9-ae83-99c45b522209","security":["ff08c80a-311b-464a-84c6-d8a499c4795d"],"responses":{"201":"15e9406a-5b1e-4d7d-85e2-d33c366b03f4","400":"11bad663-c42f-4fd6-a17e-31fed5433ebf","403":"d8fd46d3-0b8c-448b-8a70-5172b87c7d93","404":"72bce942-883f-41f2-816e-8e4ee14bfc76"},"method":"post","type":"path","servers":["7ff90826-cc44-4842-930d-97d79ccb01c7"],"path":"/invitation/connection/{connection_id}","baseUrlOptions":["https://external.nectarclimate.com/v2"],"title":"Create Reconnect Invitation","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"c17c0833-e28c-46b7-8688-04a1d9d4ba2e":{"in":"path","name":"connection_id","schema":{"type":"string","format":"uuid","isRequired":true,"description":"ID of the connection to create a reconnect invitation for.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"ID of the connection to create a reconnect invitation for.","required":true}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Request body for creating an invitation that lets a contributor update credentials on an existing connection.","properties":{"allowedEmails":{"type":"array","items":{"type":"string","format":"email","minLength":1,"uniqueKey":"allowedEmails.items.[INDEX]","typeLabel":"string\u003cemail>"},"description":"Restrict the invitation to these email addresses. If empty, anyone with the link can use it.","uniqueKey":"allowedEmails","typeLabel":"string\u003cemail>[]"},"expiresInSeconds":{"type":"integer","minimum":60,"description":"Number of seconds until the invitation expires. Omit to create a non-expiring invitation.","uniqueKey":"expiresInSeconds","typeLabel":"integer"},"maxUses":{"type":"integer","minimum":1,"description":"Maximum number of times this invitation can be used. For reconnect invitations this is typically 1.","uniqueKey":"maxUses","typeLabel":"integer"},"sendEmail":{"type":"boolean","default":false,"description":"If true and allowedEmails is non-empty, sends the invitation link to each email address.","uniqueKey":"sendEmail","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"allowedEmails":["jsmith@example.com"],"expiresInSeconds":61,"maxUses":2,"sendEmail":false}}},"exampleType":"generated"},"application/x-www-form-urlencoded":{"schema":{"type":"object","description":"Request body for creating an invitation that lets a contributor update credentials on an existing connection.","properties":{"allowedEmails":{"type":"array","items":{"type":"string","format":"email","minLength":1,"uniqueKey":"allowedEmails.items.[INDEX]","typeLabel":"string\u003cemail>"},"description":"Restrict the invitation to these email addresses. If empty, anyone with the link can use it.","uniqueKey":"allowedEmails","typeLabel":"string\u003cemail>[]"},"expiresInSeconds":{"type":"integer","minimum":60,"description":"Number of seconds until the invitation expires. Omit to create a non-expiring invitation.","uniqueKey":"expiresInSeconds","typeLabel":"integer"},"maxUses":{"type":"integer","minimum":1,"description":"Maximum number of times this invitation can be used. For reconnect invitations this is typically 1.","uniqueKey":"maxUses","typeLabel":"integer"},"sendEmail":{"type":"boolean","default":false,"description":"If true and allowedEmails is non-empty, sends the invitation link to each email address.","uniqueKey":"sendEmail","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"allowedEmails":["jsmith@example.com"],"expiresInSeconds":61,"maxUses":2,"sendEmail":false}}},"exampleType":"generated"},"multipart/form-data":{"schema":{"type":"object","description":"Request body for creating an invitation that lets a contributor update credentials on an existing connection.","properties":{"allowedEmails":{"type":"array","items":{"type":"string","format":"email","minLength":1,"uniqueKey":"allowedEmails.items.[INDEX]","typeLabel":"string\u003cemail>"},"description":"Restrict the invitation to these email addresses. If empty, anyone with the link can use it.","uniqueKey":"allowedEmails","typeLabel":"string\u003cemail>[]"},"expiresInSeconds":{"type":"integer","minimum":60,"description":"Number of seconds until the invitation expires. Omit to create a non-expiring invitation.","uniqueKey":"expiresInSeconds","typeLabel":"integer"},"maxUses":{"type":"integer","minimum":1,"description":"Maximum number of times this invitation can be used. For reconnect invitations this is typically 1.","uniqueKey":"maxUses","typeLabel":"integer"},"sendEmail":{"type":"boolean","default":false,"description":"If true and allowedEmails is non-empty, sends the invitation link to each email address.","uniqueKey":"sendEmail","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"allowedEmails":["jsmith@example.com"],"expiresInSeconds":61,"maxUses":2,"sendEmail":false}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"15e9406a-5b1e-4d7d-85e2-d33c366b03f4":{"content":{"application/json":{"schema":{"type":"object","description":"An invitation that grants an external contributor access to create or update a connection.","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the invitation.","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"token":{"type":"string","description":"Opaque token used in the invitation URL. This is the value embedded in invitationUrl.","isRequired":true,"uniqueKey":"token","typeLabel":"string"},"invitationType":{"type":"string","description":"CREATE_CONNECTION — invitation to connect a new utility account. EDIT_CONNECTION — invitation to update credentials on an existing connection.","isRequired":true,"uniqueKey":"invitationType","typeLabel":"string"},"status":{"type":"string","description":"ACTIVE — can still be used. EXPIRED — past its expiration time. REVOKED — manually invalidated. FULFILLED — reached its maximum use count.","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"invitationUrl":{"type":"string","description":"Full URL to send to the recipient. Opening this link takes them to the connection form.","isRequired":true,"uniqueKey":"invitationUrl","typeLabel":"string"},"companyId":{"type":"string","format":"uuid","description":"The company this invitation belongs to.","isRequired":true,"uniqueKey":"companyId","typeLabel":"string\u003cuuid>"},"connectionId":{"oneOf":[{"type":"string","format":"uuid","description":"For EDIT_CONNECTION invitations, the ID of the connection to update. Null for CREATE_CONNECTION invitations.","isRequired":true,"uniqueKey":"connectionId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"For EDIT_CONNECTION invitations, the ID of the connection to update. Null for CREATE_CONNECTION invitations.","isRequired":true,"uniqueKey":"connectionId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"connectionId","typeLabel":"string\u003cuuid> | null"},"allowedEmails":{"type":"array","items":{"type":"string","format":"email","uniqueKey":"allowedEmails.items.[INDEX]","typeLabel":"string\u003cemail>"},"description":"Email addresses allowed to use this invitation. Empty list means anyone with the link can use it.","isRequired":true,"uniqueKey":"allowedEmails","typeLabel":"string\u003cemail>[]"},"expiresAt":{"oneOf":[{"type":"string","format":"date-time","description":"When the invitation expires. Null means it never expires.","isRequired":true,"uniqueKey":"expiresAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the invitation expires. Null means it never expires.","isRequired":true,"uniqueKey":"expiresAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"expiresAt","typeLabel":"string\u003cdate-time> | null"},"maxUses":{"oneOf":[{"type":"integer","description":"Maximum number of times this invitation can be used. Null means unlimited.","isRequired":true,"uniqueKey":"maxUses.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Maximum number of times this invitation can be used. Null means unlimited.","isRequired":true,"uniqueKey":"maxUses.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"maxUses","typeLabel":"integer | null"},"useCount":{"type":"integer","description":"How many times this invitation has been used so far.","isRequired":true,"uniqueKey":"useCount","typeLabel":"integer"},"created":{"type":"string","format":"date-time","description":"When the invitation was created.","isRequired":true,"uniqueKey":"created","typeLabel":"string\u003cdate-time>"},"createdAt":{"type":"string","format":"date-time","description":"Deprecated. Use 'created' instead.","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"prefill":{"oneOf":[{"type":"object","description":"Pre-populated form data for CREATE_CONNECTION invitations. Empty object for EDIT_CONNECTION invitations.","properties":{"datasourceId":{"type":"string","format":"uuid","description":"ID of a known utility provider to lock into the connection form. Use GET /v2/datasource to discover IDs. Mutually exclusive with `url`.","uniqueKey":"prefill.oneOf.0.datasourceId","typeLabel":"string\u003cuuid>"},"url":{"type":"string","format":"uri","description":"Web address of the utility company's website to pre-populate in the connection form. Legacy option kept for backwards compatibility; prefer `datasourceId` when the provider already exists in the catalog. Mutually exclusive with `datasourceId`.","maxLength":5000,"uniqueKey":"prefill.oneOf.0.url","typeLabel":"string\u003curi>"},"initialSites":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"prefill.oneOf.0.initialSites.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Site IDs to pre-select. Each site must belong to the invitation's company and be accessible by the API key.","uniqueKey":"prefill.oneOf.0.initialSites","typeLabel":"string\u003cuuid>[]"},"utilityTypes":{"type":"array","items":{"enum":["ELECTRICITY","GAS","WATER","SEWER","DISTRICT","WASTE","FUEL","MISC","REFRIGERANT","SOLAR","TELECOM"],"type":"string","description":"* `ELECTRICITY` - Electricity\n* `GAS` - Gas\n* `WATER` - Water\n* `SEWER` - Sewer\n* `DISTRICT` - District\n* `WASTE` - Waste\n* `FUEL` - Fuel\n* `MISC` - Misc\n* `REFRIGERANT` - Refrigerant\n* `SOLAR` - Solar\n* `TELECOM` - Telecom","uniqueKey":"prefill.oneOf.0.utilityTypes.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Utility types to pre-select (e.g. ELECTRICITY, GAS, WATER).","uniqueKey":"prefill.oneOf.0.utilityTypes","typeLabel":"enum\u003cstring>[]"},"country":{"type":"string","description":"Country of the utility company to pre-populate.\n\n* `AF` - Af\n* `AL` - Al\n* `DZ` - Dz\n* `AS` - As\n* `AD` - Ad\n* `AO` - Ao\n* `AI` - Ai\n* `AQ` - Aq\n* `AG` - Ag\n* `AR` - Ar\n* `AM` - Am\n* `AW` - Aw\n* `AU` - Au\n* `AT` - At\n* `AZ` - Az\n* `BS` - Bs\n* `BH` - Bh\n* `BD` - Bd\n* `BB` - Bb\n* `BY` - By\n* `BE` - Be\n* `BZ` - Bz\n* `BJ` - Bj\n* `BM` - Bm\n* `BT` - Bt\n* `BO` - Bo\n* `BQ` - Bq\n* `BA` - Ba\n* `BW` - Bw\n* `BV` - Bv\n* `BR` - Br\n* `IO` - Io\n* `BN` - Bn\n* `BG` - Bg\n* `BF` - Bf\n* `BI` - Bi\n* `KH` - Kh\n* `CM` - Cm\n* `CA` - Ca\n* `CV` - Cv\n* `KY` - Ky\n* `CF` - Cf\n* `TD` - Td\n* `CL` - Cl\n* `CN` - Cn\n* `CX` - Cx\n* `CC` - Cc\n* `CO` - Co\n* `KM` - Km\n* `CG` - Cg\n* `CD` - Cd\n* `CK` - Ck\n* `CR` - Cr\n* `HR` - Hr\n* `CU` - Cu\n* `CW` - Cw\n* `CY` - Cy\n* `CZ` - Cz\n* `CI` - Ci\n* `DK` - Dk\n* `DJ` - Dj\n* `DM` - Dm\n* `DO` - Do\n* `EC` - Ec\n* `EG` - Eg\n* `SV` - Sv\n* `GQ` - Gq\n* `ER` - Er\n* `EE` - Ee\n* `ET` - Et\n* `FK` - Fk\n* `FO` - Fo\n* `FJ` - Fj\n* `FI` - Fi\n* `FR` - Fr\n* `GF` - Gf\n* `PF` - Pf\n* `TF` - Tf\n* `GA` - Ga\n* `GM` - Gm\n* `GE` - Ge\n* `DE` - De\n* `GH` - Gh\n* `GI` - Gi\n* `GR` - Gr\n* `GL` - Gl\n* `GD` - Gd\n* `GP` - Gp\n* `GU` - Gu\n* `GT` - Gt\n* `GG` - Gg\n* `GN` - Gn\n* `GW` - Gw\n* `GY` - Gy\n* `HT` - Ht\n* `HM` - Hm\n* `VA` - Va\n* `HN` - Hn\n* `HK` - Hk\n* `HU` - Hu\n* `IS` - Is\n* `IN` - In\n* `ID` - Id\n* `IR` - Ir\n* `IQ` - Iq\n* `IE` - Ie\n* `IM` - Im\n* `IL` - Il\n* `IT` - It\n* `JM` - Jm\n* `JP` - Jp\n* `JE` - Je\n* `JO` - Jo\n* `KZ` - Kz\n* `KE` - Ke\n* `KI` - Ki\n* `KP` - Kp\n* `KR` - Kr\n* `KW` - Kw\n* `KG` - Kg\n* `LA` - La\n* `LV` - Lv\n* `LB` - Lb\n* `LS` - Ls\n* `LR` - Lr\n* `LY` - Ly\n* `LI` - Li\n* `LT` - Lt\n* `LU` - Lu\n* `MO` - Mo\n* `MK` - Mk\n* `MG` - Mg\n* `MW` - Mw\n* `MY` - My\n* `MV` - Mv\n* `ML` - Ml\n* `MT` - Mt\n* `MH` - Mh\n* `MQ` - Mq\n* `MR` - Mr\n* `MU` - Mu\n* `YT` - Yt\n* `MX` - Mx\n* `FM` - Fm\n* `MD` - Md\n* `MC` - Mc\n* `MN` - Mn\n* `ME` - Me\n* `MS` - Ms\n* `MA` - Ma\n* `MZ` - Mz\n* `MM` - Mm\n* `NA` - Na\n* `NR` - Nr\n* `NP` - Np\n* `NL` - Nl\n* `NC` - Nc\n* `NZ` - Nz\n* `NI` - Ni\n* `NE` - Ne\n* `NG` - Ng\n* `NU` - Nu\n* `NF` - Nf\n* `MP` - Mp\n* `NO` - No\n* `OM` - Om\n* `PK` - Pk\n* `PW` - Pw\n* `PS` - Ps\n* `PA` - Pa\n* `PG` - Pg\n* `PY` - Py\n* `PE` - Pe\n* `PH` - Ph\n* `PN` - Pn\n* `PL` - Pl\n* `PT` - Pt\n* `PR` - Pr\n* `QA` - Qa\n* `RO` - Ro\n* `RU` - Ru\n* `RW` - Rw\n* `RE` - Re\n* `BL` - Bl\n* `SH` - Sh\n* `KN` - Kn\n* `LC` - Lc\n* `MF` - Mf\n* `PM` - Pm\n* `VC` - Vc\n* `WS` - Ws\n* `SM` - Sm\n* `ST` - St\n* `SA` - Sa\n* `SN` - Sn\n* `RS` - Rs\n* `SC` - Sc\n* `SL` - Sl\n* `SG` - Sg\n* `SX` - Sx\n* `SK` - Sk\n* `SI` - Si\n* `SB` - Sb\n* `SO` - So\n* `ZA` - Za\n* `GS` - Gs\n* `SS` - Ss\n* `ES` - Es\n* `LK` - Lk\n* `SD` - Sd\n* `SR` - Sr\n* `SJ` - Sj\n* `SZ` - Sz\n* `SE` - Se\n* `CH` - Ch\n* `SY` - Sy\n* `TW` - Tw\n* `TJ` - Tj\n* `TZ` - Tz\n* `TH` - Th\n* `TL` - Tl\n* `TG` - Tg\n* `TK` - Tk\n* `TO` - To\n* `TT` - Tt\n* `TN` - Tn\n* `TR` - Tr\n* `TM` - Tm\n* `TC` - Tc\n* `TV` - Tv\n* `UG` - Ug\n* `UA` - Ua\n* `AE` - Ae\n* `GB` - Gb\n* `US` - Us\n* `UM` - Um\n* `UY` - Uy\n* `UZ` - Uz\n* `VU` - Vu\n* `VE` - Ve\n* `VN` - Vn\n* `VG` - Vg\n* `VI` - Vi\n* `WF` - Wf\n* `EH` - Eh\n* `YE` - Ye\n* `ZM` - Zm\n* `ZW` - Zw\n* `AX` - Ax","enum":["AF","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","HR","CU","CW","CY","CZ","CI","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RO","RU","RW","RE","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","AX"],"uniqueKey":"prefill.oneOf.0.country","typeLabel":"enum\u003cstring>"},"connectionOwnerEmail":{"type":"string","format":"email","description":"Email address of the person responsible for this connection. Shown in the connection form and stored on the resulting connection.","uniqueKey":"prefill.oneOf.0.connectionOwnerEmail","typeLabel":"string\u003cemail>"},"dataCollectionStartDate":{"type":"string","format":"date","description":"Earliest date from which to collect utility data.","uniqueKey":"prefill.oneOf.0.dataCollectionStartDate","typeLabel":"string\u003cdate>"},"externalId":{"type":"string","description":"Your own identifier for the connection that will be created. Stored on the resulting connection and returned in all connection responses.","maxLength":200,"uniqueKey":"prefill.oneOf.0.externalId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"prefill.oneOf.0","typeLabel":"object"},{"type":"null","description":"Pre-populated form data for CREATE_CONNECTION invitations. Empty object for EDIT_CONNECTION invitations.","isRequired":true,"uniqueKey":"prefill.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"prefill","typeLabel":"object | null"},"createdConnections":{"type":"array","items":{"type":"object","description":"A connection that was created when someone used a CREATE_CONNECTION invitation.","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the connection.","isRequired":true,"uniqueKey":"createdConnections.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"datasourceName":{"oneOf":[{"type":"string","description":"Name of the utility provider, or null if not yet resolved.","isRequired":true,"uniqueKey":"createdConnections.items.[INDEX].datasourceName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Name of the utility provider, or null if not yet resolved.","isRequired":true,"uniqueKey":"createdConnections.items.[INDEX].datasourceName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"createdConnections.items.[INDEX].datasourceName","typeLabel":"string | null"},"status":{"type":"string","description":"Current connection status (e.g. CONNECTED, PENDING, ERROR).","isRequired":true,"uniqueKey":"createdConnections.items.[INDEX].status","typeLabel":"string"},"created":{"type":"string","format":"date-time","description":"When this connection was created.","isRequired":true,"uniqueKey":"createdConnections.items.[INDEX].created","typeLabel":"string\u003cdate-time>"}},"required":["created","datasourceName","id","status"],"uniqueKey":"createdConnections.items.[INDEX]","typeLabel":"object"},"description":"Connections that were created by recipients of this invitation. Only populated for CREATE_CONNECTION invitations; empty list for EDIT_CONNECTION.","isRequired":true,"uniqueKey":"createdConnections","typeLabel":"object[]"}},"required":["allowedEmails","companyId","connectionId","created","createdAt","createdConnections","expiresAt","id","invitationType","invitationUrl","maxUses","prefill","status","token","useCount"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","token":"\u003cstring>","invitationType":"\u003cstring>","status":"\u003cstring>","invitationUrl":"\u003cstring>","companyId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","connectionId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","allowedEmails":["jsmith@example.com"],"expiresAt":"2023-11-07T05:31:56Z","maxUses":123,"useCount":123,"created":"2023-11-07T05:31:56Z","createdAt":"2023-11-07T05:31:56Z","prefill":{"datasourceId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","url":"\u003cstring>","initialSites":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"utilityTypes":["ELECTRICITY"],"country":"AF","connectionOwnerEmail":"jsmith@example.com","dataCollectionStartDate":"2023-12-25","externalId":"\u003cstring>"},"createdConnections":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","datasourceName":"\u003cstring>","status":"\u003cstring>","created":"2023-11-07T05:31:56Z"}]}}},"exampleType":"generated"}},"description":"","exampleType":"generated"},"11bad663-c42f-4fd6-a17e-31fed5433ebf":{"description":"Validation error.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"d8fd46d3-0b8c-448b-8a70-5172b87c7d93":{"description":"Forbidden: insufficient permissions.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"72bce942-883f-41f2-816e-8e4ee14bfc76":{"description":"Connection not found.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"ff08c80a-311b-464a-84c6-d8a499c4795d":{"ExternalAuthentication":{"type":"apiKey","in":"header","name":"X-API-KEY","scopes":[]}}},"servers":{"7ff90826-cc44-4842-930d-97d79ccb01c7":{"url":"https://external.nectarclimate.com/v2","description":"Nectar API Server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-KEY","scopes":[]},"schema":{"title":"X-API-KEY","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ExternalAuthentication","name":"X-API-KEY"}],"title":"ExternalAuthentication"}]},"originalFileLocation":"api-reference/openapi-v2.json"},"subdomain":"nectar","siteName":"Nectar Knowledge Base","title":"Create Reconnect Invitation - Nectar Knowledge Base","navMaps":{"firstHrefInVersion":{"v2.2":{"href":"/api-reference/v2-2/invitations/create-reconnect-invitation","matchLevel":1},"v2.1":{"href":"/api-reference/v2-1/invitations/create-reconnect-invitation","matchLevel":1},"v2.0":{"href":"/api-reference/v2-0/invitations/create-reconnect-invitation","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-09-29T02:18:56.534Z","originalFileLocation":"api-reference/v2-0/invitations/create-reconnect-invitation.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Create an invitation that lets a contributor update credentials on an existing utility account connection. The response includes an invitationUrl to send to the contributor.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Nectar Knowledge Base\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/nectar/gZW-eyAyHdprqGVs/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/nectar/gZW-eyAyHdprqGVs/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/nectar/gZW-eyAyHdprqGVs/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/nectar/gZW-eyAyHdprqGVs/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/nectar/gZW-eyAyHdprqGVs/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/nectar/gZW-eyAyHdprqGVs/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/nectar/gZW-eyAyHdprqGVs/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/nectar/gZW-eyAyHdprqGVs/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/nectar/gZW-eyAyHdprqGVs/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Reconnect Invitation - Nectar Knowledge Base\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create an invitation that lets a contributor update credentials on an existing utility account connection. The response includes an invitationUrl to send to the contributor.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Nectar Knowledge Base\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://nectarclimate.com/docs/api-reference/v2-0/invitations/create-reconnect-invitation\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://nectar.mintlify.app/_mintlify/api/og/v2?division=Invitations\u0026amp;title=Create+Reconnect+Invitation\u0026amp;description=Create+an+invitation+that+lets+a+contributor+update+credentials+on+an+existing+utility+account+connection.+The+response+includes+an+%60invitationUrl%60+to+send+to+t\u0026amp;theme=d6f36af3d51813e1674f4062\u0026amp;signature=b5d00fd8e2c7de1af064a37198fa04f64de17b43fc963eb94b2636a6fb894cc2\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create Reconnect Invitation - Nectar Knowledge Base\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create an invitation that lets a contributor update credentials on an existing utility account connection. The response includes an invitationUrl to send to the contributor.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://nectar.mintlify.app/_mintlify/api/og/v2?division=Invitations\u0026amp;title=Create+Reconnect+Invitation\u0026amp;description=Create+an+invitation+that+lets+a+contributor+update+credentials+on+an+existing+utility+account+connection.+The+response+includes+an+%60invitationUrl%60+to+send+to+t\u0026amp;theme=d6f36af3d51813e1674f4062\u0026amp;signature=b5d00fd8e2c7de1af064a37198fa04f64de17b43fc963eb94b2636a6fb894cc2\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/nectar/gZW-eyAyHdprqGVs/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Nectar Knowledge Base\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#092A54\">\u003clink data-mint-head rel=\"canonical\" href=\"https://nectarclimate.com/docs/api-reference/v2-0/invitations/create-reconnect-invitation\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/v2-0/invitations/create-reconnect-invitation.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://nectarclimate.com/#organization\",\"name\":\"Nectar Knowledge Base\",\"url\":\"https://nectarclimate.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/nectar/XTv6xdiQoWsCyg3G/logo/light.svg?fit=max\u0026auto=format\u0026n=XTv6xdiQoWsCyg3G\u0026q=85\u0026s=8b28e329f1aad1d1fbf3022d179cd34e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://nectarclimate.com/docs#website\",\"name\":\"Nectar Knowledge Base\",\"url\":\"https://nectarclimate.com/docs\",\"publisher\":{\"@id\":\"https://nectarclimate.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://nectarclimate.com/docs/api-reference/v2-0/invitations/create-reconnect-invitation#webpage\",\"url\":\"https://nectarclimate.com/docs/api-reference/v2-0/invitations/create-reconnect-invitation\",\"name\":\"Create Reconnect Invitation\",\"description\":\"Create an invitation that lets a contributor update credentials on an existing utility account connection. The response includes an invitationUrl to send to the contributor.\",\"dateModified\":\"2026-09-29T02:18:56.534Z\",\"isPartOf\":{\"@id\":\"https://nectarclimate.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://nectarclimate.com/docs/api-reference/v2-0/invitations/create-reconnect-invitation#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://nectarclimate.com/docs/api-reference/v2-0/invitations/create-reconnect-invitation#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Invitations\",\"item\":\"https://nectarclimate.com/docs/api-reference/v2-0/invitations/get-invitation-detail\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Reconnect Invitation\",\"item\":\"https://nectarclimate.com/docs/api-reference/v2-0/invitations/create-reconnect-invitation\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://nectarclimate.com/docs/api-reference/v2-0/invitations/create-reconnect-invitation#apireference\",\"headline\":\"Create Reconnect Invitation\",\"name\":\"Create Reconnect Invitation\",\"description\":\"Create an invitation that lets a contributor update credentials on an existing utility account connection. The response includes an invitationUrl to send to the contributor.\",\"url\":\"https://nectarclimate.com/docs/api-reference/v2-0/invitations/create-reconnect-invitation\",\"mainEntityOfPage\":{\"@id\":\"https://nectarclimate.com/docs/api-reference/v2-0/invitations/create-reconnect-invitation#webpage\"},\"dateModified\":\"2026-09-29T02:18:56.534Z\",\"publisher\":{\"@id\":\"https://nectarclimate.com/#organization\"},\"isPartOf\":{\"@id\":\"https://nectarclimate.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Nectar Knowledge Base\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Nectar Knowledge Base","nav":{"global":{"anchors":[{"anchor":"Dashboard","icon":"gauge","href":"https://dash.nectarclimate.com"},{"anchor":"Support","icon":"envelope","href":"mailto:support@nectarclimate.com"},{"anchor":"Status","icon":"signal","href":"https://stats.uptimerobot.com/rICwZ0oMLI"}]},"tabs":[{"tab":"Knowledge Base","pages":[{"title":"Knowledge Base","href":""}]},{"tab":"Developer Guide","pages":[{"title":"Developer Guide","href":"/developer-guide/for-developers"}]},{"tab":"API Reference","versions":[{"version":"v2.2","pages":[{"title":"v2.2","href":"/api-reference/v2-2/invitations/create-reconnect-invitation"}]},{"version":"v2.1","pages":[{"title":"v2.1","href":"/api-reference/v2-1/invitations/create-reconnect-invitation"}]},{"version":"v2.0","groups":[{"group":"Accounts","pages":[{"title":"Update an account","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json patch /account/{account_id}","href":"/api-reference/v2-0/accounts/update-an-account"},{"title":"Bulk update accounts for a company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json patch /account/bulk","href":"/api-reference/v2-0/accounts/bulk-update-accounts-for-a-company"}]},{"group":"Companies","pages":[{"title":"Retrieve Companies","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /company","href":"/api-reference/v2-0/companies/retrieve-companies"},{"title":"Create Company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json post /company","href":"/api-reference/v2-0/companies/create-company"},{"title":"Get Company Details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /company/{company_id}","href":"/api-reference/v2-0/companies/get-company-details"},{"title":"Delete Company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json delete /company/{company_id}","href":"/api-reference/v2-0/companies/delete-company"},{"title":"Update Company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json patch /company/{company_id}","href":"/api-reference/v2-0/companies/update-company"}]},{"group":"Webhook Portal","pages":[{"title":"Get Webhook Settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /configure_webhook","href":"/api-reference/v2-0/webhook-portal/get-webhook-settings"},{"title":"Webhook Portal","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json post /configure_webhook","href":"/api-reference/v2-0/webhook-portal/webhook-portal"},{"title":"Update Webhook Settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json patch /configure_webhook","href":"/api-reference/v2-0/webhook-portal/update-webhook-settings"}]},{"group":"Connections","pages":[{"title":"Create Magic Link for Updating a Utility Account Connection","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.json get /connection/{connection_id}","href":"/api-reference/v2-0/connections/create-magic-link-for-updating-a-utility-account-connection"},{"title":"Get an Utility Account Connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /connection/{connection_id}/details","href":"/api-reference/v2-0/connections/get-an-utility-account-connection"},{"title":"Update an Utility Account Connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json patch /connection/{connection_id}/details","href":"/api-reference/v2-0/connections/update-an-utility-account-connection"},{"title":"Confirm a utility account connection for a company.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json patch /connection/{connection_id}/status","href":"/api-reference/v2-0/connections/confirm-a-utility-account-connection-for-a-company"},{"title":"Get Company Utility Account Connections","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /connection/company/{company_id}","href":"/api-reference/v2-0/connections/get-company-utility-account-connections"},{"title":"Create Basic Utility Account Connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json post /connection/company/{company_id}","href":"/api-reference/v2-0/connections/create-basic-utility-account-connection"},{"title":"Create Magic Link for Creating a Utility Account Connection","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.json get /connection/company/{company_id}/link","href":"/api-reference/v2-0/connections/create-magic-link-for-creating-a-utility-account-connection"},{"title":"Create Magic Link with Prefilled Data for Creating a Utility Account Connection","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v2.json post /connection/company/{company_id}/link","href":"/api-reference/v2-0/connections/create-magic-link-with-prefilled-data-for-creating-a-utility-account-connection"},{"title":"Search Utility Providers","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /datasource","href":"/api-reference/v2-0/connections/search-utility-providers"}]},{"group":"Documents","pages":[{"title":"Get Document Details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /document/{document_id}","href":"/api-reference/v2-0/documents/get-document-details"},{"title":"Update Document Details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json patch /document/{document_id}","href":"/api-reference/v2-0/documents/update-document-details"},{"title":"Get Demand Meters by Document","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /document/{document_id}/demandmeters","href":"/api-reference/v2-0/documents/get-demand-meters-by-document"},{"title":"Get Documents by Company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /document/company/{company_id}","href":"/api-reference/v2-0/documents/get-documents-by-company"},{"title":"Get Documents by Connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /document/connection/{connection_id}","href":"/api-reference/v2-0/documents/get-documents-by-connection"},{"title":"Get Documents by Site","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /document/site/{site_id}","href":"/api-reference/v2-0/documents/get-documents-by-site"}]},{"group":"Intervals","pages":[{"title":"Get Intervals by Connection (BETA)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /interval/connection/{connection_id}","href":"/api-reference/v2-0/intervals/get-intervals-by-connection-beta"}]},{"group":"Invitations","pages":[{"title":"Get Invitation Detail","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /invitation/{invitation_id}","href":"/api-reference/v2-0/invitations/get-invitation-detail"},{"title":"Revoke Invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json post /invitation/{invitation_id}/revoke","href":"/api-reference/v2-0/invitations/revoke-invitation"},{"title":"List Invitations by Company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /invitation/company/{company_id}","href":"/api-reference/v2-0/invitations/list-invitations-by-company"},{"title":"Create Connection Invitation","description":"Create an invitation that lets an external contributor connect a new utility account to the specified company. The response includes an `invitationUrl` to send to the contributor. Supports optional email restrictions, expiration, usage limits, and pre-filled form data.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json post /invitation/company/{company_id}","href":"/api-reference/v2-0/invitations/create-connection-invitation"},{"title":"Create Reconnect Invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json post /invitation/connection/{connection_id}","href":"/api-reference/v2-0/invitations/create-reconnect-invitation"}]},{"group":"Jobs","pages":[{"title":"Get Job Status Details","description":"Gets the status and details of a document processing job given a job id. When you submit documents through our API, each submission creates a job that can be tracked. The job status will always be one of 'PENDING', 'COMPLETED', or 'FAILED'. COMPLETED includes jobs that finished without creating new documents — for example duplicates, non-utility files, or password-protected files. In general jobs will not fail due to retry policies. However, when a job does show 'FAILED' as the status, please get in touch with our team at support@nectarclimate.com. When the job is completed, this endpoint returns the ids of processed documents plus any duplicates, non-utility files, password-protected files, and processing errors. You can also subscribe to the `job.completed.v2` webhook instead of polling.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /job/{job_id}","href":"/api-reference/v2-0/jobs/get-job-status-details"},{"title":"Submit Job via Single Document Upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json post /job/company/{company_id}","href":"/api-reference/v2-0/jobs/submit-job-via-single-document-upload"},{"title":"Submit Job via Bulk Document Upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json post /job/company/{company_id}/bulk","href":"/api-reference/v2-0/jobs/submit-job-via-bulk-document-upload"}]},{"group":"Meters","pages":[{"title":"Get Meter Details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /meter/{meter_id}","href":"/api-reference/v2-0/meters/get-meter-details"},{"title":"Update Meter Details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json patch /meter/{meter_id}","href":"/api-reference/v2-0/meters/update-meter-details"},{"title":"Get Meters by Company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /meter/company/{company_id}","href":"/api-reference/v2-0/meters/get-meters-by-company"},{"title":"Get Meters by Connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /meter/connection/{connection_id}","href":"/api-reference/v2-0/meters/get-meters-by-connection"},{"title":"Get Meters by Document","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /meter/document/{document_id}","href":"/api-reference/v2-0/meters/get-meters-by-document"},{"title":"Get Meters by Site","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /meter/site/{site_id}","href":"/api-reference/v2-0/meters/get-meters-by-site"}]},{"group":"Ping","pages":[{"title":"Ping Test Endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /ping","href":"/api-reference/v2-0/ping/ping-test-endpoint"}]},{"group":"Sites","pages":[{"title":"Get Site Details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /site/{site_id}","href":"/api-reference/v2-0/sites/get-site-details"},{"title":"Delete Site","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json delete /site/{site_id}","href":"/api-reference/v2-0/sites/delete-site"},{"title":"Update Site","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json patch /site/{site_id}","href":"/api-reference/v2-0/sites/update-site"},{"title":"Get Sites by Company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /site/company/{company_id}","href":"/api-reference/v2-0/sites/get-sites-by-company"},{"title":"Create Site","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json post /site/company/{company_id}","href":"/api-reference/v2-0/sites/create-site"}]},{"group":"Team","pages":[{"title":"Get Team and Billing Information","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /team","href":"/api-reference/v2-0/team/get-team-and-billing-information"},{"title":"Update Team and Billing Information","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json patch /team","href":"/api-reference/v2-0/team/update-team-and-billing-information"}]},{"group":"Usage Data","pages":[{"title":"Get Usage Data Details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /usage/{msud_id}","href":"/api-reference/v2-0/usage-data/get-usage-data-details"},{"title":"Delete Usage Data","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json delete /usage/{msud_id}","href":"/api-reference/v2-0/usage-data/delete-usage-data"},{"title":"Update Usage Data","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json patch /usage/{msud_id}","href":"/api-reference/v2-0/usage-data/update-usage-data"},{"title":"Get Usage Data by Company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /usage/company/{company_id}","href":"/api-reference/v2-0/usage-data/get-usage-data-by-company"},{"title":"Get Usage Data by Utility Connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /usage/connection/{connection_id}","href":"/api-reference/v2-0/usage-data/get-usage-data-by-utility-connection"},{"title":"Get Usage Data by Document","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /usage/document/{document_id}","href":"/api-reference/v2-0/usage-data/get-usage-data-by-document"},{"title":"Get Usage Data by Meter","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /usage/meter/{meter_id}","href":"/api-reference/v2-0/usage-data/get-usage-data-by-meter"},{"title":"Get Usage Data by Site","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v2.json get /usage/site/{site_id}","href":"/api-reference/v2-0/usage-data/get-usage-data-by-site"}]},{"group":"Webhook Payloads","pages":[{"title":"Webhook for utility account connection creation v2","version":null,"deprecated":null,"openapi":"/api-reference/openapi-v2.json webhook connection.created.v2","href":"/api-reference/v2-0/webhook-payloads/webhook-for-utility-account-connection-creation-v2"},{"title":"Webhook for updates to an existing utility account connection v2","version":null,"deprecated":null,"openapi":"/api-reference/openapi-v2.json webhook connection.updated.v2","href":"/api-reference/v2-0/webhook-payloads/webhook-for-updates-to-an-existing-utility-account-connection-v2"},{"title":"Webhook for connection status changes v2","version":null,"deprecated":null,"openapi":"/api-reference/openapi-v2.json webhook connection.validated.v2","href":"/api-reference/v2-0/webhook-payloads/webhook-for-connection-status-changes-v2"},{"title":"Webhook for new document availability v2","version":null,"deprecated":null,"openapi":"/api-reference/openapi-v2.json webhook document.created.v2","href":"/api-reference/v2-0/webhook-payloads/webhook-for-new-document-availability-v2"},{"title":"Webhook for document update v2","version":null,"deprecated":null,"openapi":"/api-reference/openapi-v2.json webhook document.updated.v2","href":"/api-reference/v2-0/webhook-payloads/webhook-for-document-update-v2"},{"title":"Webhook for document deletion v2","version":null,"deprecated":null,"openapi":"/api-reference/openapi-v2.json webhook document.deleted.v2","href":"/api-reference/v2-0/webhook-payloads/webhook-for-document-deletion-v2"},{"title":"Webhook for synced interval data","version":null,"deprecated":null,"openapi":"/api-reference/openapi-v2.json webhook intervals.synced","href":"/api-reference/v2-0/webhook-payloads/webhook-for-synced-interval-data"},{"title":"Webhook for document upload job completion","version":null,"deprecated":null,"openapi":"/api-reference/openapi-v2.json webhook job.completed.v2","href":"/api-reference/v2-0/webhook-payloads/webhook-for-document-upload-job-completion"}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"title":"Create Reconnect Invitation - Nectar Knowledge Base","buildId":"dpl_GvhK4qVXq51DpfYJLCtPpYNN4YHN","deploymentId":"dpl_GvhK4qVXq51DpfYJLCtPpYNN4YHN","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bg4Z7D_G.js","utils-Biz734EK.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C6F9YHs6.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BoJjY_VP.js","snippetPresets-CnZ-mOFh.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-DC_SB2pp.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BYKtOiIP.js","shallow-COAac_UD.js","getApiPlaygroundDisplay-BV4Viqi2.js","CodeSnippet-DDgW-JXl.js","CodeSnippets-CP1LpNhG.js","Page-BeiUfucV.js","getPastedJson-Cvgvbfmv.js","icon-D-H368xH.js","MethodPill-CXSxH1VW.js","DuplicateIcon-JcbBzF1x.js","createIcon-BDt_aHZM.js","DynamicMarkdown-DO1Fz7ar.js","SectionHeading-mwKBArs3.js","axios-vUo_bRtp.js","Markdown-C3KUTGJN.js","clsx-C6CAjViH.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C3vb5JQZ.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C8Hisf3g.js"]}