SQsquarespace
Contacts

Replace address book entry

Replaces an address book entry for the contact with a full JSON body. When updating the entry that is currently the default, setting "defaultShipping" from true to false has no effect. Requires OAuth website scope website.contacts, or API key scope CONTACT, or OAuth website scope website.profiles (OAuth only).

put/v1/contacts/{contactId}/address-book/{addressBookEntryId}

Request

Path parameters

contactIdstring required

The contact's ID.

addressBookEntryIdstring required

The address book entry's ID.

Headers

Authorizationstring required

API key or OAuth access token

User-Agentstring required

User Agent

Request body

defaultShippingboolean

Whether this entry should be the default shipping address. When updating the entry that is currently the default, changing this value from true to false has no effect.

Example request

{
  "address": {
    "city": "Springfield",
    "countryCode": "US",
    "firstName": "John",
    "lastName": "Doe",
    "line1": "100 Main St",
    "line2": "Apt 1A",
    "phoneNumber": "215-555-4321",
    "postalCode": "10900",
    "region": "IL"
  }
}

Response

The updated address book entry.

Example response

{
  "addressBookEntry": {
    "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"
  }
}

Changes

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