> Markdown versions of all pages of this connector library are available by appending `.md` to the page URL. For the full index of connectors, see [llms.txt](https://connectors.appmixer.com/llms.txt).

# appmixer.square.core.CreateCustomer

- Component: `appmixer.square.core.CreateCustomer`
- Kind: Action
- Version: 1.0.0
- Visibility: Public
- Connector: [appmixer.square 1.1.3](https://connectors.appmixer.com/connector/appmixer.square/1.1.3.md)
- Component page: <https://connectors.appmixer.com/connector/appmixer.square/1.1.3/component/appmixer.square.core.CreateCustomer>

Create a new customer profile.

## Input ports

### Port `in`

| Field | Type | Description |
| --- | --- | --- |
| Given Name (`given_name`) | text | The first name of the customer. |
| Family Name (`family_name`) | text | The last name of the customer. |
| Company Name (`company_name`) | text | The name of the customer's workplace. |
| Email Address (`email_address`) | text | The email address of the customer. |
| Phone Number (`phone_number`) | text | Customer phone number (9-16 digits). Use national format for same-country customers or E.164 international format (+1234567890) for different countries. Special characters allowed: ( ) - . space |

## Output ports

### Port `out`

| Field | Type | Description |
| --- | --- | --- |
| Customer Id (`id`) | string | - |
| Created At (`created_at`) | string | - |
| Updated At (`updated_at`) | string | - |
| Given Name (`given_name`) | string | - |
| Family Name (`family_name`) | string | - |
| Nickname (`nickname`) | string | - |
| Email Address (`email_address`) | string | - |
| Address (`address`) | object | - |
| Phone Number (`phone_number`) | string | - |
| Company Name (`company_name`) | string | - |
| Preferences (`preferences`) | object | - |
| Creation Source (`creation_source`) | string | - |
| Version (`version`) | number | - |

## Full metadata (component.json)

```json
{
  "name": "appmixer.square.core.CreateCustomer",
  "author": "Appmixer <info@appmixer.com>",
  "description": "Create a new customer profile.",
  "version": "1.0.0",
  "private": false,
  "auth": {
    "service": "appmixer:square"
  },
  "quota": {
    "manager": "appmixer:square",
    "resources": "requests"
  },
  "inPorts": [
    {
      "name": "in",
      "schema": {
        "type": "object",
        "properties": {
          "given_name": {
            "type": "string"
          },
          "family_name": {
            "type": "string"
          },
          "company_name": {
            "type": "string"
          },
          "email_address": {
            "type": "string"
          },
          "phone_number": {
            "type": "string"
          }
        },
        "anyOf": [
          {
            "required": [
              "given_name"
            ]
          },
          {
            "required": [
              "family_name"
            ]
          },
          {
            "required": [
              "company_name"
            ]
          },
          {
            "required": [
              "email_address"
            ]
          },
          {
            "required": [
              "phone_number"
            ]
          }
        ]
      },
      "inspector": {
        "inputs": {
          "given_name": {
            "type": "text",
            "tooltip": "The first name of the customer.",
            "label": "Given Name",
            "index": 0
          },
          "family_name": {
            "type": "text",
            "tooltip": "The last name of the customer.",
            "label": "Family Name",
            "index": 1
          },
          "company_name": {
            "type": "text",
            "tooltip": "The name of the customer's workplace.",
            "label": "Company Name",
            "index": 2
          },
          "email_address": {
            "type": "text",
            "tooltip": "The email address of the customer.",
            "label": "Email Address",
            "index": 3
          },
          "phone_number": {
            "type": "text",
            "tooltip": "Customer phone number (9-16 digits). Use national format for same-country customers or E.164 international format (+1234567890) for different countries. Special characters allowed: ( ) - . space",
            "label": "Phone Number",
            "index": 4
          }
        }
      }
    }
  ],
  "outPorts": [
    {
      "name": "out",
      "options": [
        {
          "label": "Customer Id",
          "value": "id",
          "schema": {
            "type": "string",
            "example": "JDKYHBWT1D4F8MFH63DBMEN8Y4"
          }
        },
        {
          "label": "Created At",
          "value": "created_at",
          "schema": {
            "type": "string",
            "example": "2024-03-15T10:30:00.000Z"
          }
        },
        {
          "label": "Updated At",
          "value": "updated_at",
          "schema": {
            "type": "string",
            "example": "2024-03-15T12:45:00.000Z"
          }
        },
        {
          "label": "Given Name",
          "value": "given_name",
          "schema": {
            "type": "string",
            "example": "Amelia"
          }
        },
        {
          "label": "Family Name",
          "value": "family_name",
          "schema": {
            "type": "string",
            "example": "Earhart"
          }
        },
        {
          "label": "Nickname",
          "value": "nickname",
          "schema": {
            "type": "string",
            "example": "Amy"
          }
        },
        {
          "label": "Email Address",
          "value": "email_address",
          "schema": {
            "type": "string",
            "example": "amelia.earhart@example.com"
          }
        },
        {
          "label": "Address",
          "value": "address",
          "schema": {
            "type": "object",
            "properties": {
              "address_line_1": {
                "type": "string",
                "title": "Address.Address Line 1"
              },
              "locality": {
                "type": "string",
                "title": "Address.Locality"
              },
              "administrative_district_level_1": {
                "type": "string",
                "title": "Address.Administrative District Level 1"
              },
              "postal_code": {
                "type": "string",
                "title": "Address.Postal Code"
              }
            },
            "example": {
              "address_line_1": "500 Electric Ave",
              "locality": "New York",
              "administrative_district_level_1": "NY",
              "postal_code": "10003"
            }
          }
        },
        {
          "label": "Phone Number",
          "value": "phone_number",
          "schema": {
            "type": "string",
            "example": "+12125551234"
          }
        },
        {
          "label": "Company Name",
          "value": "company_name",
          "schema": {
            "type": "string",
            "example": "Acme Corp"
          }
        },
        {
          "label": "Preferences",
          "value": "preferences",
          "schema": {
            "type": "object",
            "properties": {
              "email_unsubscribed": {
                "type": "boolean",
                "title": "Preferences.Email Unsubscribed"
              }
            },
            "example": {
              "email_unsubscribed": false
            }
          }
        },
        {
          "label": "Creation Source",
          "value": "creation_source",
          "schema": {
            "type": "string",
            "example": "THIRD_PARTY"
          }
        },
        {
          "label": "Version",
          "value": "version",
          "schema": {
            "type": "number",
            "example": 1
          }
        }
      ]
    }
  ],
  "icon": "(data URI omitted)"
}
```
