Update Contact

Update Contact

PUT /v1/customers/{customer_id}/contacts/{contact_id}

Update Contact

cURL

curl --request PUT \
  --url https://api.wizcommerce.com/v1/customers/{customer_id}/contacts/{contact_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "reference_id": "CUS123",
  "first_name": "John",
  "last_name": "Doe",
  "email": "[e-mail]",
  "phone": "[phone]",
  "designation": "Sales Manager",
  "is_default": true,
  "attributes": [
    {
      "name": "1234567890",
      "value": "red"
    }
  ]
}
'

import requests

url = "https://api.wizcommerce.com/v1/customers/{customer_id}/contacts/{contact_id}"

payload = {
    "reference_id": "CUS123",
    "first_name": "John",
    "last_name": "Doe",
    "email": "[e-mail]",
    "phone": "[phone]",
    "designation": "Sales Manager",
    "is_default": True,
    "attributes": [
        {
            "name": "1234567890",
            "value": "red"
        }
    ]
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    reference_id: 'CUS123',
    first_name: 'John',
    last_name: 'Doe',
    email: '[e-mail]',
    phone: '[phone]',
    designation: 'Sales Manager',
    is_default: true,
    attributes: [{name: '1234567890', value: 'red'}]
  })
};

fetch('https://api.wizcommerce.com/v1/customers/{customer_id}/contacts/{contact_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.wizcommerce.com/v1/customers/{customer_id}/contacts/{contact_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'reference_id' => 'CUS123',
    'first_name' => 'John',
    'last_name' => 'Doe',
    'email' => '[e-mail]',
    'phone' => '[phone]',
    'designation' => 'Sales Manager',
    'is_default' => true,
    'attributes' => [
        [
                'name' => '1234567890',
                'value' => 'red'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.wizcommerce.com/v1/customers/{customer_id}/contacts/{contact_id}"

	payload := strings.NewReader("{\n  \"reference_id\": \"CUS123\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Doe\",\n  \"email\": \"[e-mail]\",\n  \"phone\": \"[phone]\",\n  \"designation\": \"Sales Manager\",\n  \"is_default\": true,\n  \"attributes\": [\n    {\n      \"name\": \"1234567890\",\n      \"value\": \"red\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.wizcommerce.com/v1/customers/{customer_id}/contacts/{contact_id}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reference_id\": \"CUS123\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Doe\",\n  \"email\": \"[e-mail]\",\n  \"phone\": \"[phone]\",\n  \"designation\": \"Sales Manager\",\n  \"is_default\": true,\n  \"attributes\": [\n    {\n      \"name\": \"1234567890\",\n      \"value\": \"red\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.wizcommerce.com/v1/customers/{customer_id}/contacts/{contact_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reference_id\": \"CUS123\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Doe\",\n  \"email\": \"[e-mail]\",\n  \"phone\": \"[phone]\",\n  \"designation\": \"Sales Manager\",\n  \"is_default\": true,\n  \"attributes\": [\n    {\n      \"name\": \"1234567890\",\n      \"value\": \"red\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

201

{
  "data": {
    "id": "0c05a9a7-84ed-46f0-819b-653545730920",
    "reference_id": "CUS123",
    "first_name": "John",
    "last_name": "Doe",
    "email": "[e-mail]",
    "phone": "[phone]",
    "designation": "Sales Manager",
    "status": "active",
    "is_default": false,
    "attributes": [
      {
        "id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
        "name": "Color",
        "value": "Red",
        "created_by": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
        "updated_by": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
        "created_at": "2021-01-01T00:00:00Z",
        "updated_at": "2021-01-01T00:00:00Z"
      }
    ],
    "created_at": "2025-01-01T15:04:05Z",
    "updated_at": "2025-01-01T15:04:05Z"
  }
}

{
  "code": "<string>",
  "message": "<string>",
  "details": [
    {
      "field": "<string>",
      "reason": "<string>"
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "details": [
    {
      "field": "<string>",
      "reason": "<string>"
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "details": [
    {
      "field": "<string>",
      "reason": "<string>"
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "details": [
    {
      "field": "<string>",
      "reason": "<string>"
    }
  ]
}

The PUT request is used to fully replace an existing entity with a new one based on the provided ID. This means:

• All fields in the request body will overwrite the existing entity.
• Any missing fields will be removed from the entity.
• The request is idempotent, meaning multiple identical PUT requests will always result in the same final state.

Authorizations

X-API-Key · string · header · required

API Key for authentication

Path Parameters

customer_id · string · required

customer_id

contact_id · string · required

contact_id

Body

application/json

request

reference_id · string

Maximum string length: 255

Example:

"CUS123"

first_name · string

Maximum string length: 50

Example:

"John"

last_name · string

Maximum string length: 50

Example:

"Doe"

email · string

Example:

"[e-mail]"

phone · string

Phone number in E.164 format

Example:

"[phone]"

designation · string

Maximum string length: 50

Example:

"Sales Manager"

is_default · boolean

When true, sets this as the primary contact. Omitted/false does not change the current primary contact.

attributes · object[]

Show child attributes

Response

201

application/json

Created

data · object

Show child attributes