SQsquarespace
Contacts

Create address book entry

Creates a new address book entry for the contact. If this is the contact's only address book entry after creation, it becomes the default shipping address even when defaultShipping is false. Requires OAuth website scope website.contacts, or API key scope CONTACT, or OAuth website scope website.profiles (OAuth only).

post/v1/contacts/{contactId}/address-book

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

defaultShippingboolean

Whether this entry should be the default shipping address. If this is the only address book entry for the contact after creation, it becomes the default even when set to false.

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 created 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.