--- title: update consumer email slug: api-documentation/update-consumer-email docTags: createdAt: 2026-08-27T17:02:13.658Z --- { "id": "nptX9k77V_tdD2XDwVq-U", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://api.upstartcommerce.com/v1/customer/{customerId}/emails", "servers": [ { "url": "https://api.upstartcommerce.com/v1/customer/{customerId}/emails" } ], "name": "update consumer email", "description": "

This endpoint allows administrators to add a consumer's email address.

\n

Authorized permissions:

\n", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "customerId", "type": "string", "description": "Unique identifier for the consumer that the call should be interacting with." } ], "headerParameters": [ { "kind": "required", "name": "x-upstart-tenant", "type": "string", "description": "Tenant identifier associated with the site this call is for." }, { "kind": "optional", "name": "x-upstart-site", "type": "string", "description": "Unique identifier for the site." } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "customType": "EmailAddress", "schema": [ { "name": "address", "kind": "required", "type": "string", "description": "This property contains the actual email address.", "example": "example@example.com", "format": "email" }, { "name": "label", "kind": "required", "type": "string", "description": "

This is a user-friendly identifier to be used by the consumer to select an email.

", "example": "Work email" } ], "modelRef": "#/components/schemas/EmailAddress", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "NoChannelPortalAccess", "name": "NoChannelPortalAccess", "kind": "optional", "type": "http", "description": "

This authentication is required for clients to interact with any of the management APIs. Similar to 'LoggedIn', it indicates that the user has actually logged into the system, but in this case with a management role.

", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "

Success-email address added.

", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "The request contained information that the server was unable to process. Appropriate errors are provided in the response body.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ValidationErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ValidationErrorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "403", "description": "

An update to this resource requires the if-match and if-unmodified-since headers to be sent in order to process the request.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "FSmC9_KW8M3_K18iarqG2", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.upstartcommerce.com/v1/customer/{customerId}/emails \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --header 'x-upstart-tenant: string' \\\n --data-raw '{\n \"address\": \"example@example.com\",\n \"label\": \"Work email\"\n }'" }, { "id": "u1CxQFj-mxRXZNmojALlB", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-upstart-tenant\", \"string\");\n\nvar raw = JSON.stringify({\n \"address\": \"example@example.com\",\n \"label\": \"Work email\"\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/v1/customer/{customerId}/emails\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "ZVUbhrgyzKWA6y1BKoBPg", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/customer/{customerId}/emails\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\nrequest.body = JSON.dump({\n \"address\": \"example@example.com\",\n \"label\": \"Work email\"\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "jcIlogDsa1jJqWaLtSNrV", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/customer/{customerId}/emails\"\n\npayload = json.dumps({\n \"address\": \"example@example.com\",\n \"label\": \"Work email\"\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "FSmC9_KW8M3_K18iarqG2" }, "results": { "languages": [ { "id": "ZgmS4BMMN8mgSKxZkzjxh", "language": "200", "code": "// Success-email address added.\n" }, { "id": "G4pTJP5n955jlXvyGhHOd", "language": "400", "code": "// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n}" }, { "id": "g_0CPF51e5RixAWx7D1XT", "language": "401", "code": "// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "Zbrtl_3YuE1RLiiA65xXB", "language": "403", "code": "// An update to this resource requires the if-match and if-unmodified-since headers to be sent in order to process the request.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" } ], "selectedLanguageId": "ZgmS4BMMN8mgSKxZkzjxh" } }, "children": [ { "text": "" } ] }