SQsquarespace
Contacts

Update contact

Updates a contact using JSON merge patch. Requires OAuth website scope website.contacts, or API key scope CONTACT, or OAuth website scope website.profiles (OAuth only).

patch/v1/contacts/{contactId}

Request

Path parameters

contactIdstring required

The contact's ID.

Headers

Authorizationstring required

API key or OAuth access token

User-Agentstring required

User Agent

Request body

firstNamestring

The contact's first name.

lastNamestring

The contact's last name.

localestring

The contact's locale.

Example request

{
  "firstName": "John",
  "lastName": "Smith",
  "locale": "en-US",
  "primaryEmail": {
    "email": "johnsmith@mail.com",
    "acceptsMarketing": true
  }
}

Response

The updated contact.

Example response

{
  "contact": {
    "defaultShippingAddress": {
      "address": {
        "city": "Springfield",
        "countryCode": "US",
        "firstName": "John",
        "lastName": "Doe",
        "line1": "100 Main St",
        "line2": "Apt 1A",
        "phoneNumber": "215-555-4321",
        "postalCode": "10900",
        "region": "IL"
      },
      "id": "5f8d0d55b54764421b7156aa"
    },
    "id": "64a7e3d2c8f1b95e30a14d2b",
    "locale": "en-US",
    "primaryEmail": {
      "email": "jane.doe@example.com"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.