Skip to main content
PATCH
/
contacts
/
{id}
Update a contact
curl --request PATCH \
  --url https://api.bookingshake.io/api/contacts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "position": "Head of Operations",
  "phone": "+33611111111",
  "optin_marketing": false
}
'
import requests

url = "https://api.bookingshake.io/api/contacts/{id}"

payload = {
"position": "Head of Operations",
"phone": "+33611111111",
"optin_marketing": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({position: 'Head of Operations', phone: '+33611111111', optin_marketing: false})
};

fetch('https://api.bookingshake.io/api/contacts/{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.bookingshake.io/api/contacts/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'position' => 'Head of Operations',
'phone' => '+33611111111',
'optin_marketing' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$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.bookingshake.io/api/contacts/{id}"

payload := strings.NewReader("{\n \"position\": \"Head of Operations\",\n \"phone\": \"+33611111111\",\n \"optin_marketing\": false\n}")

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

req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://api.bookingshake.io/api/contacts/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"position\": \"Head of Operations\",\n \"phone\": \"+33611111111\",\n \"optin_marketing\": false\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.bookingshake.io/api/contacts/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"position\": \"Head of Operations\",\n \"phone\": \"+33611111111\",\n \"optin_marketing\": false\n}"

response = http.request(request)
puts response.read_body
{
  "message": "success",
  "data": {
    "id": "contact-456",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com",
    "phone": "+33611111111",
    "landline_phone": "+33145678901",
    "title": "CEO",
    "position": "Head of Operations",
    "avatar": null,
    "comments": null,
    "account_id": "account-123",
    "optin_marketing": false,
    "optin_general": false,
    "address_line_1": "10 rue Example",
    "address_line_2": null,
    "postal_code": "75001",
    "city": "Paris",
    "country": "France",
    "created_at": 1731493800000,
    "custom_u1v2w3x4y5": "VIP",
    "custom_z6a7b8c9d0": null
  }
}
{
"message": "no updatable fields provided"
}
{
"message": "not found"
}
{
"message": "Rate limit exceeded",
"data": {
"limit": 60,
"window": "60 seconds",
"remaining": 0,
"resetAt": "2025-11-17T14:30:00.000Z",
"retryAfter": 45
}
}
{
"message": "error"
}

Authorizations

Authorization
string
header
required

Bearer authentication using your BookingShake API key. Retrieve your API key from Settings > Integrations in your BookingShake dashboard.

Path Parameters

id
string
required

Contact ID (the id field carried by the contact.* webhooks).

Body

application/json

Fields that can be updated on a contact. All fields are optional (partial update): only the fields present in the body are modified. Same conventions as the response (English snake_case names). String fields are trimmed and limited to 255 characters; email must be a valid email address; optin_marketing/optin_general are booleans; account_id must reference an existing account within the contact's venue or venues group. Pass null on any field to clear it. The country field is stored verbatim. Custom fields (custom_) configured for your venue can be set too (string or array of strings); an unknown custom field key is rejected with 400. id and created_at are read-only and ignored. At least one field must be provided.

first_name
string | null

First name

Maximum string length: 255
last_name
string | null

Last name

Maximum string length: 255
email
string<email> | null

Email address (validated; pass null to clear)

Maximum string length: 255
phone
string | null

Mobile phone number

Maximum string length: 255
landline_phone
string | null

Landline phone number

Maximum string length: 255
title
string | null

Contact's title

Maximum string length: 255
position
string | null

Job position

Maximum string length: 255
avatar
string | null

Avatar image URL

Maximum string length: 255
comments
string | null

Free-text notes about the contact

Maximum string length: 255
account_id
string | null

ID of an existing account (company) to link the contact to; must be within the contact's venue or venues group. Pass null to unlink.

optin_marketing
boolean | null

Marketing communications opt-in

optin_general
boolean | null

General communications opt-in

address_line_1
string | null

Address

Maximum string length: 255
address_line_2
string | null

Address, line 2

Maximum string length: 255
postal_code
string | null

Postal code

Maximum string length: 255
city
string | null

City

Maximum string length: 255
country
string | null

Country, stored verbatim

Maximum string length: 255
{key}
any

Custom fields (custom_) configured for your venue: a string or an array of strings. An unknown custom field key is rejected with 400.

Response

Contact updated successfully. Returns the full contact in its post-update state.

message
string
Example:

"success"

data
object

A contact (person) attached to your venue, optionally linked to an account. Every field is present with an explicit null when unset. The country field is verbatim as entered. account_id is the raw ID of the linked account (or null). Custom fields (custom_<uuid>) configured for your venue are included, also with explicit null when unset.