--- title: Creates the contact. slug: commerce-connect-15/service-api/NqcI-creates-the-contact docTags: createdAt: 2026-10-09T17:33:32.660Z --- { "id": "eS01fdIRS0nM54UgoEFbJ", "type": "api-oas-v2", "data": { "method": "POST", "url": "/episerverapi/commerce/customers/contact/{userId}", "servers": [], "name": "Creates the contact.", "description": "", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "userId", "type": "string", "description": "

User ID (GUID).

", "format": "uuid" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "text/plain", "application/json", "text/json" ], "default": "text/plain" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "Contact model.", "customType": "ContactModel", "schema": [ { "name": "primaryKeyId", "kind": "optional", "type": "string", "nullable": true, "description": "

Contact ID (GUID).

", "format": "uuid" }, { "name": "addresses", "kind": "optional", "type": "array", "nullable": true, "description": "Contacts addresses.", "modelRef": "#/components/schemas/AddressModel", "customType": "AddressModel[]", "schema": [ { "name": "addressId", "kind": "optional", "type": "string", "nullable": true, "description": "

Address ID (GUID).

", "format": "uuid" }, { "name": "modified", "kind": "optional", "type": "string", "nullable": true, "description": "Last modified date.", "format": "date-time" }, { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "Address name." }, { "name": "firstName", "kind": "optional", "type": "string", "nullable": true, "description": "First name." }, { "name": "lastName", "kind": "optional", "type": "string", "nullable": true, "description": "Last name." }, { "name": "countryName", "kind": "optional", "type": "string", "nullable": true, "description": "Country name." }, { "name": "countryCode", "kind": "optional", "type": "string", "nullable": true, "description": "Country code." }, { "name": "city", "kind": "optional", "type": "string", "nullable": true, "description": "City." }, { "name": "postalCode", "kind": "optional", "type": "string", "nullable": true, "description": "

Postal code (Zip code).

" }, { "name": "line1", "kind": "optional", "type": "string", "nullable": true, "description": "Address line 1." }, { "name": "line2", "kind": "optional", "type": "string", "nullable": true, "description": "Address line 2." }, { "name": "regionName", "kind": "optional", "type": "string", "nullable": true, "description": "Region name." }, { "name": "regionCode", "kind": "optional", "type": "string", "nullable": true, "description": "Region code." }, { "name": "email", "kind": "optional", "type": "string", "nullable": true, "description": "Email." }, { "name": "isShippingAddress", "kind": "optional", "type": "boolean", "description": "Flag to indicate if this is a shipping address or not." }, { "name": "isBillingAddress", "kind": "optional", "type": "boolean", "description": "Flag to indicate if this is a billing address or not." }, { "name": "daytimePhoneNumber", "kind": "optional", "type": "string", "nullable": true, "description": "Daytime phone number." }, { "name": "eveningPhoneNumber", "kind": "optional", "type": "string", "nullable": true, "description": "Evening phone number." }, { "name": "organization", "kind": "optional", "type": "string", "nullable": true, "description": "Organization name." }, { "name": "addressType", "kind": "optional", "type": "array", "nullable": true, "description": "Address type.", "example": "", "itemType": "integer", "customType": "integer[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "firstName", "kind": "optional", "type": "string", "nullable": true, "description": "First name." }, { "name": "lastName", "kind": "optional", "type": "string", "nullable": true, "description": "Last name." }, { "name": "email", "kind": "optional", "type": "string", "nullable": true, "description": "Email." }, { "name": "registrationSource", "kind": "optional", "type": "string", "nullable": true, "description": "Registration source." } ], "modelRef": "#/components/schemas/ContactModel", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "The contact is saved.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Contact model.", "customType": "ContactModel", "schema": [ { "name": "primaryKeyId", "kind": "optional", "type": "string", "nullable": true, "description": "

Contact ID (GUID).

", "format": "uuid" }, { "name": "addresses", "kind": "optional", "type": "array", "nullable": true, "description": "Contacts addresses.", "modelRef": "#/components/schemas/AddressModel", "customType": "AddressModel[]", "schema": [ { "name": "addressId", "kind": "optional", "type": "string", "nullable": true, "description": "

Address ID (GUID).

", "format": "uuid" }, { "name": "modified", "kind": "optional", "type": "string", "nullable": true, "description": "Last modified date.", "format": "date-time" }, { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "Address name." }, { "name": "firstName", "kind": "optional", "type": "string", "nullable": true, "description": "First name." }, { "name": "lastName", "kind": "optional", "type": "string", "nullable": true, "description": "Last name." }, { "name": "countryName", "kind": "optional", "type": "string", "nullable": true, "description": "Country name." }, { "name": "countryCode", "kind": "optional", "type": "string", "nullable": true, "description": "Country code." }, { "name": "city", "kind": "optional", "type": "string", "nullable": true, "description": "City." }, { "name": "postalCode", "kind": "optional", "type": "string", "nullable": true, "description": "

Postal code (Zip code).

" }, { "name": "line1", "kind": "optional", "type": "string", "nullable": true, "description": "Address line 1." }, { "name": "line2", "kind": "optional", "type": "string", "nullable": true, "description": "Address line 2." }, { "name": "regionName", "kind": "optional", "type": "string", "nullable": true, "description": "Region name." }, { "name": "regionCode", "kind": "optional", "type": "string", "nullable": true, "description": "Region code." }, { "name": "email", "kind": "optional", "type": "string", "nullable": true, "description": "Email." }, { "name": "isShippingAddress", "kind": "optional", "type": "boolean", "description": "Flag to indicate if this is a shipping address or not." }, { "name": "isBillingAddress", "kind": "optional", "type": "boolean", "description": "Flag to indicate if this is a billing address or not." }, { "name": "daytimePhoneNumber", "kind": "optional", "type": "string", "nullable": true, "description": "Daytime phone number." }, { "name": "eveningPhoneNumber", "kind": "optional", "type": "string", "nullable": true, "description": "Evening phone number." }, { "name": "organization", "kind": "optional", "type": "string", "nullable": true, "description": "Organization name." }, { "name": "addressType", "kind": "optional", "type": "array", "nullable": true, "description": "Address type.", "example": "", "itemType": "integer", "customType": "integer[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "firstName", "kind": "optional", "type": "string", "nullable": true, "description": "First name." }, { "name": "lastName", "kind": "optional", "type": "string", "nullable": true, "description": "Last name." }, { "name": "email", "kind": "optional", "type": "string", "nullable": true, "description": "Email." }, { "name": "registrationSource", "kind": "optional", "type": "string", "nullable": true, "description": "Registration source." } ], "modelRef": "#/components/schemas/ContactModel", "isExpanded": true } ] }, { "statusCode": "400", "description": "If the contact model is not valid.", "jsonExample": "", "isExpanded": true }, { "statusCode": "401", "description": "If user does not have enough permission for this request.", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "mHUWZ2paD9IMi-hs8XDh2", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url /episerverapi/commerce/customers/contact/{userId} \\\n --header 'accept: text/plain'" }, { "id": "uNpZM3xkZ38v5etSC247-", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"text/plain\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"/episerverapi/commerce/customers/contact/{userId}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "4Dl06dhyT15eOdJxKCis_", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"/episerverapi/commerce/customers/contact/{userId}\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"text/plain\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = http.request(request)\nputs response.read_body\n" }, { "id": "L-JsQuUuc8ngmGJRoDuVM", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"/episerverapi/commerce/customers/contact/{userId}\"\n\npayload = {}\nheaders = {\n 'accept': 'text/plain',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "mHUWZ2paD9IMi-hs8XDh2" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// The contact is saved.\n{\n \"primaryKeyId\": \"\",\n \"addresses\": [\n {\n \"addressId\": \"\",\n \"modified\": \"\",\n \"name\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"countryName\": \"\",\n \"countryCode\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"regionName\": \"\",\n \"regionCode\": \"\",\n \"email\": \"\",\n \"isShippingAddress\": false,\n \"isBillingAddress\": false,\n \"daytimePhoneNumber\": \"\",\n \"eveningPhoneNumber\": \"\",\n \"organization\": \"\",\n \"addressType\": [\n 0\n ]\n }\n ],\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"registrationSource\": \"\"\n}" }, { "id": "response-1-400", "language": "400", "code": "// If the contact model is not valid.\n" }, { "id": "response-2-401", "language": "401", "code": "// If user does not have enough permission for this request.\n" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }