SbPublicApiUpdateCustomerRequest

snowbee.SbPublicApiUpdateCustomerRequest

object · non-null

All fields are optional.

countryIsoCodestringnullableoptional

ISO 3166-1 alpha-2 country code

Example"NO"

electronicReceiptbooleannullableoptional

Whether the customer wants electronic receipts

Exampletrue

emailstringnullableoptional

Example"ola.nordmann@example.com"

firstNamestringnullableoptional

Example"Ola"

languageIsoCodestringnullableoptional

ISO 639-2 language code

Example"NOR"

lastNamestringnullableoptional

Example"Nordmann"

loyaltyProgramsarray of objectnullableoptional

Loyalty program enrollments to set for this customer

Show item fields

Loyalty program enrollment status for a customer

enrolledbooleannon-nullrequired: Whether the customer is enrolled in this loyalty program
Exampletrue
idstringnon-nullrequired: Unique identifier of the loyalty program
Example"01234567-89ab-cdef-0123-456789abcdef"
namestringnon-nullrequired: Example"Premium Members Club"

newsletterbooleannullableoptional

Whether the customer subscribes to the newsletter

Examplefalse

phonestringnullableoptional

Customer's phone number in E.164 format

Example"+4790123456"

View raw schema

{
  "type": "object",
  "description": "All fields are optional.",
  "properties": {
    "countryIsoCode": {
      "type": [
        "null",
        "string"
      ],
      "description": "ISO 3166-1 alpha-2 country code",
      "example": "NO",
      "title": "String"
    },
    "electronicReceipt": {
      "type": [
        "null",
        "boolean"
      ],
      "description": "Whether the customer wants electronic receipts",
      "example": "true",
      "title": "Boolean"
    },
    "email": {
      "type": [
        "null",
        "string"
      ],
      "example": "ola.nordmann@example.com",
      "title": "String"
    },
    "firstName": {
      "type": [
        "null",
        "string"
      ],
      "example": "Ola",
      "title": "String"
    },
    "languageIsoCode": {
      "type": [
        "null",
        "string"
      ],
      "description": "ISO 639-2 language code",
      "example": "NOR",
      "title": "String"
    },
    "lastName": {
      "type": [
        "null",
        "string"
      ],
      "example": "Nordmann",
      "title": "String"
    },
    "loyaltyPrograms": {
      "type": [
        "null",
        "array"
      ],
      "description": "Loyalty program enrollments to set for this customer",
      "items": {
        "$ref": "#/components/schemas/snowbee.SbPublicApiCustomerLoyaltyProgramResponse"
      },
      "title": "List<SbPublicApiCustomerLoyaltyProgramResponse>"
    },
    "newsletter": {
      "type": [
        "null",
        "boolean"
      ],
      "description": "Whether the customer subscribes to the newsletter",
      "example": "false",
      "title": "Boolean"
    },
    "phone": {
      "type": [
        "null",
        "string"
      ],
      "description": "Customer's phone number in E.164 format",
      "example": "+4790123456",
      "title": "String"
    }
  },
  "title": "SbPublicApiUpdateCustomerRequest"
}