# Create customer user.

Create customer user.

Endpoint: POST /customer-users
Version: 1.0.0
Security: Token

## Request fields (application/json):

  - `first_name` (string, required)
    First name.
    Example: "John"

  - `last_name` (string, required)
    Last name.
    Example: "Doe"

  - `email` (string, required)
    Email address of the user.
    Example: "john.doe@gmail.com"

  - `phone` (string,null)
    A phone number represented in whichever standards specified by the user, typically ###-###-#### (separated by hyphens).
    Example: "(123) 456-7890"

  - `license_number` (string,null)
    The license number of a real estate agent.
    Example: "12345678"

  - `avatar_url` (string,null)
    The avatar image URL of a user.
    Example: "https://picsum.photos/300"

  - `add_to_customer_team` (boolean, required)
    Whether to add the user to a customer team.
    Example: true

  - `customer_team_id` (string)
    The ID of the customer team to add the user to. Required if add_to_customer_team is true.
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `role` (string)
    The role of the user in the customer team. Required if add_to_customer_team is true.
    Enum: "admin", "member"

  - `defines_new_team` (boolean,null)
    Whether to define a new team for the user. Required if add_to_customer_team is false.
    Example: true

  - `name` (string,null)
    The name of the new team. Required if defines_new_team is true.
    Example: "John Doe Reality"

  - `description` (string,null)
    The description of the new team. Used if defines_new_team is true.
    Example: "Internal notes about the team."

  - `brokerage_name` (string,null)
    The name of the brokerage. Used if defines_new_team is true.
    Example: "John Doe Realty"

  - `timezone` (string,null)
    The default timezone for the customer.
    Example: "America/New_York"

## Response 200 fields (application/json):

  - `object` (string)
    String representing the object's type. Objects of the same type share the same schema.
    Example: "GROUP"

  - `id` (string, required)
    ID of the entity. UUID Version 4.
    Example: "00000000-0000-4000-8000-000000000000"

  - `type` (string)
    The type of the group. Can be CREATOR, AGENT, or BROKERAGE, and may dictate the attributes of the group returned.
    Enum: "CREATOR", "AGENT", "BROKERAGE"

  - `name` (string)
    The name of the group.
    Example: "John Doe Reality"

  - `email` (string,null)
    The email address of a group.
    Example: "john.doe@gmail.com"

  - `phone` (string,null)
    A phone number represented in whichever standards specified by the group, typically ###-###-#### (separated by hyphens).
    Example: "6175550173"

  - `website_url` (string,null)
    The website URL of a group.
    Example: "https://www.aryeo.com"

  - `logo_url` (string,null)
    The logo URL of a group.
    Example: "https://picsum.photos/300"

  - `office_name` (string,null)
    The name of the brokerage or team of a real estate agent. Only returned if group's type is AGENT.
    Example: "John Doe Brokerage"

  - `license_number` (string,null)
    The license number of a real estate agent. Only returned if group's type is AGENT.
    Example: "12345678"

  - `timezone` (string,null)
    The default timezone for the group.
    Example: "America/New_York"

  - `currency` (string)
    The default currency for the group.
    Enum: "USD", "CAD", "GBP", "CHF", "EUR", "AUD", "NZD", "ZAR", "DKK"

  - `slug` (string,null)
    The slug for the group.
    Example: "example-photography"

  - `order_page_url` (string,null)
    The order page URL for the group.
    Example: "https://example-photography.aryeo.com/order"

  - `feature_flags` (array,null)
    An array of feature flags for the group.
    Enum: "alternate_unbranded_property_site_url", "avalara_tax_syncing", "avalara_taxes", "byop", "calendar", "calendar_event_title_modified", "customer_teams_order_form_landing_page_override", "customer_teams_product_preselect", "customer_portal_mobile_apps", "customer_select_on_order_form_products_step", "database_external_calendar_events", "default_reschedule_toggle_false", "download_center_fb_boost_1", "embedded_payments", "housecall_pro", "idp_migration_in_progress", "listings_create_page", "listings_page", "min_hour_targets", "max_travel_distance", "quickbooks_app", "require_photographer_confirmations", "restricted_image_downloads", "showcase_app", "showcase_order_form_visibility_designations", "showingtime", "team_member_restrictions", "team_member_hide_customer_pii", "virtual_staging_ai", "virtuals1_custom_sms_notification_messages", "webhooks", "zapier", "zendesk", "zillow_3d_home", "zillow_media_exclusives", "zillow_photographer_branding", "zillow_rentals"

  - `order_page_background_color` (string,null)
    The background color for the order page (has a hex value) for the group.
    Example: "#FF0000"

  - `default_order_form` (object)
    An order form is a form that is used to submit an order.

  - `default_order_form.object` (string)
    A canonical value representing a resource.
    Enum: "ORDER_FORM"

  - `default_order_form.title` (string, required)
    The title or name of the order form.
    Example: "BQ's Photography Order Form"

  - `default_order_form.type` (string, required)
    The type of the order form, indicating whether the order form is an Aryeo order form or that of another scheduling service provider.
    Enum: "ARYEO", "EXTERNAL"

  - `default_order_form.url` (string, required)
    A URL of a publicly-accessible webpage for this order form.
    Example: "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000"

  - `default_order_form.is_public` (boolean)
    Indicates if the order form is publicly visible to all customers on the order form page
    Example: true

  - `default_order_form.thumbnail_url` (string,null)
    A thumbnail image URL for the order form.
    Example: "https://picsum.photos/300"

  - `default_order_form.use_territory_awareness` (boolean)
    Indicates if the order form is uses territories to filter available users and products.
    Example: true

  - `default_order_form.availability_style` (string)
    The scheduling style the order form should use to for timeslot selection.
    Enum: "TIME", "TIME_OF_DAY", "LEGACY", "DATETIME_PICKER"

  - `default_order_form.slot_interval_minutes` (integer)
    How frequently slotted available times are on the order form.
    Example: 60

  - `default_order_form.use_automated_user_assignment` (boolean)
    Indicates if the order form users auto-assignment of users to appointments.
    Example: true

  - `default_order_form.automated_user_assignment_strategy` (string)
    The assignment strategy the order form should use to assign users to appointments, if applicable.
    Enum: "RECOMMENDED", "HOURS_PRIORITY", "DISTANCE", "ROUND_ROBIN", "PRIORITY_LIST"

  - `default_order_form.show_user_names` (boolean)
    Indicates if the order form should display user's names after they have been assigned to an appointment.
    Example: true

  - `default_order_form.require_upfront_payment` (boolean)
    Indicates if the order form requires an upfront payment to place the order.
    Example: true

  - `default_order_form.upfront_payment_percentage` (integer,null)
    The percentage of the order form's total price that should be paid upfront.
    Example: 50

  - `default_order_form.use_instant_appointment_scheduling` (boolean)
    Indicates if the order form instantly schedules appointments as soon as the order is placed.
    Example: true

  - `default_order_form.form_settings` (object)
    The settings for the order form.

  - `default_order_form.owner` (object)
    A collection of users that can interact with the Aryeo platform. Permissions and properties are determined based on the group's type which can be creator, agent, or brokerage.

  - `default_order_form.owner.social_profiles` (object,null)
    External profile URLs for an agent or brokerage group.

  - `default_order_form.owner.social_profiles.facebook_profile_url` (string,null)
    URL for Facebook.
    Example: "https://www.facebook.com/johndoe"

  - `default_order_form.owner.social_profiles.instagram_profile_url` (string,null)
    URL for Instagram.
    Example: "https://www.instagram.com/johndoe"

  - `default_order_form.owner.social_profiles.twitter_profile_url` (string,null)
    URL for Twitter.
    Example: "https://twitter.com/johndoe"

  - `default_order_form.owner.social_profiles.linkedin_profile_url` (string,null)
    URL for LinkedIn.
    Example: "https://www.linkedin.com/in/johndoe/"

  - `default_order_form.owner.social_profiles.zillow_profile_url` (string,null)
    URL for Zillow.
    Example: "https://www.zillow.com/profile/johndoe"

  - `default_order_form.owner.use_territory_awareness` (boolean,null)
    Indicates if the order form by default uses territories to filter available users and products.
    Example: true

  - `default_order_form.owner.availability_style` (string,null)
    The scheduling style the order form should use for timeslot selection by default.
    Enum: "TIME", "TIME_OF_DAY", "LEGACY"

  - `default_order_form.owner.slot_interval_minutes` (integer,null)
    How frequently slotted available times are on the order form by default.
    Example: 60

  - `default_order_form.owner.use_automated_user_assignment` (boolean,null)
    Indicates if the order form uses auto-assignment of users to appointments.
    Example: true

  - `default_order_form.owner.automated_user_assignment_strategy` (string,null)
    The default assignment strategy the order form should use to assign users to appointments, if applicable.
    Enum: "RECOMMENDED", "HOURS_PRIORITY", "DISTANCE", "ROUND_ROBIN", "PRIORITY_LIST"

  - `default_order_form.owner.show_user_names` (boolean,null)
    Indicates if the order form by default should display user's names after they have been assigned to an appointment.
    Example: true

  - `default_order_form.owner.use_instant_appointment_scheduling` (boolean,null)
    Indicates if the order form by default instantly schedules appointments as soon as the order is placed.
    Example: true

  - `default_order_form.owner.allow_order_cancellation` (boolean,null)
    If the group is a company, then this indicates if company allows customers to cancel orders or order items.
    Example: true

  - `default_order_form.owner.order_forms` (array,null)
    An array of order forms a vendor group provides for placing orders. Only returned if group's type is CREATOR.

  - `default_order_form.owner.owner` (object,null)
    A record of a person on the Aryeo platform.

  - `default_order_form.owner.owner.email` (string, required)
    Email address of the user.
    Example: "john.doe@gmail.com"

  - `default_order_form.owner.owner.first_name` (string,null)
    First name of the user.
    Example: "John"

  - `default_order_form.owner.owner.last_name` (string,null)
    Last name of the user.
    Example: "Doe"

  - `default_order_form.owner.owner.full_name` (string,null)
    The full name of the user.
    Example: "John Doe"

  - `default_order_form.owner.owner.internal_notes` (string,null)
    Internal notes for the user.
    Example: "Internal notes for the user."

  - `default_order_form.owner.owner.status` (string)
    The status of the user.
    Enum: "active", "inactive", "new", "sso"

  - `default_order_form.owner.owner.phone` (string,null)
    A phone number represented in whichever standards specified by the user, typically ###-###-#### (separated by hyphens).
    Example: "123456789"

  - `default_order_form.owner.owner.avatar_url` (string,null)
    The avatar image URL of a user.
    Example: "https://picsum.photos/300"

  - `default_order_form.owner.owner.relationship` (string,null)
    Describes user's relationship (access level) to a specified group. Only returned if this resource is returned as a sub-resource of a group.
    Example: "owner"

  - `default_order_form.owner.owner.sso_users` (array)
    The list of SSO users associated with this user.

  - `default_order_form.owner.owner.sso_users.sso_id` (string, required)
    SSO ID of the user
    Example: "1234"

  - `default_order_form.owner.owner.sso_users.sso_provider` (object)
    A SSO Provider contains the information pertaining to the SSO connection.

  - `default_order_form.owner.owner.sso_users.sso_provider.name` (string, required)
    Name of the provider
    Example: "Some Company"

  - `default_order_form.owner.owner.sso_users.sso_provider.provider` (string, required)
    Technology of the provider
    Example: "Auth0"

  - `default_order_form.owner.owner.is_super` (boolean,null)
    Indicates if the user is a super user.
    Example: true

  - `default_order_form.owner.users` (array,null)
    The Aryeo users associated with this group.

  - `default_order_form.owner.is_brokerage_or_brokerage_agent` (boolean,null)
    Indicates if the group is a brokerage or brokerage agent.
    Example: true

  - `default_order_form.owner.internal_notes` (string,null)
    Internal notes about the group.
    Example: "Internal notes about the group."

  - `default_order_form.owner.team_members` (array,null)
    NOTE: Users do not have team members.

  - `default_order_form.owner.customer_group` (string,null)
    NOTE: Users do not have customer groups and they are deprecated.
    Example: "null"

  - `default_order_form.owner.custom_field_entries` (array,null)
    NOTE: Need to make a migration plan for this.

  - `default_order_form.owner.created_at` (string,null)
    The date and time the group was created.
    Example: "2021-06-30T20:30:00Z"

  - `default_order_form.owner.has_restricted_photographers` (boolean,null)
    Whether the group is restricted from booking appointments with certain photographers.
    Example: true

  - `default_order_form.owner.is_payroll_enabled` (boolean,null)
    Indicates if the group has payroll enabled.
    Example: true

  - `default_order_form.owner.is_visible` (boolean,null)
    Indicates if the group is visible.
    Example: true

  - `default_order_form.owner.order_index` (integer,null)
    The order index of the group.
    Example: 1

  - `default_order_form.company` (object)
    A collection of users that can interact with the Aryeo platform. Permissions and properties are determined based on the group's type which can be creator, agent, or brokerage.

  - `billing_address` (string,null)
    The billing address of the group.
    Example: "123 Main St, Anytown, USA 12345"

  - `restricted_photographers` (array,null)
    The photographers restricted from the group.

  - `customer_team_memberships` (array)
    The list of customer team memberships associated with this group.

  - `customer_team_memberships.role` (string, required)
    The role of the customer team membership.
    Enum: "admin", "member"

  - `customer_team_memberships.invitation_accepted_at` (string,null)
    The date and time (ISO 8601 format) when the invitation was accepted.
    Example: "2025-04-01T05:59:59.999999Z"

  - `customer_team_memberships.status` (string, required)
    The status of the customer team membership.
    Enum: "deleted", "archived", "revoked", "active", "invited"

  - `customer_team_memberships.customer_team` (object, required)
    A customer group is a legacy name for what is now a customer team. A customer team is a container for customers, allowing you to apply settings such as price overrides and billing customer configurations in bulk.

  - `customer_team_memberships.customer_team.name` (string, required)
    The name of the customer team.
    Example: "John Doe Customer Group"

  - `customer_team_memberships.customer_team.description` (string,null)
    The description of the customer team.
    Example: "John Doe Customer Team is a customer team for John Doe."

  - `customer_team_memberships.customer_team.internal_notes` (string,null)
    The internal notes of the customer team.
    Example: "John Doe's customer team normally doesn't work on Fridays."

  - `customer_team_memberships.customer_team.logo_url` (string,null)
    The logo image URL of the customer team.
    Example: "https://picsum.photos/640/480"

  - `customer_team_memberships.customer_team.brokerage_name` (string,null)
    The name of the brokerage team.
    Example: "Grimes-Mante"

  - `customer_team_memberships.customer_team.brokerage_website` (string,null)
    The website URL of the brokerage team.
    Example: "http://www.tillman.info/aut-odio-qui-voluptatibus"

  - `customer_team_memberships.customer_team.affiliate_id` (string,null)
    The affliate ID for the customer team.
    Example: "JOHN_DOE"

  - `customer_team_memberships.customer_team.should_display_original_price` (boolean)
    Indicates if original prices should be displayed for this customer team.
    Example: true

  - `customer_team_memberships.customer_team.should_disable_automated_payment_reminder_email` (boolean)
    Indicates if automated payment reminder emails should be disabled for this customer team.
    Example: true

  - `customer_team_memberships.customer_team.should_lock_downloads_before_payment` (boolean,null)
    Indicates if the downloads should be locked before payment for this customer team.
    Example: true

  - `customer_team_memberships.customer_team.order_form_id` (string,null)
    The ID of the order form.
    Example: "00000000-0000-4000-8000-000000000000"

  - `customer_team_memberships.customer_team.created_at` (string,null)
    The date and time (ISO 8601 format) when the customer team was created.
    Example: "2025-03-07T13:59:03.000000Z"

  - `customer_team_memberships.customer_team.is_showingtimeplus_team` (boolean)
    Indicates if the customer team is a ShowingTime team.
    Example: true

  - `customer_team_memberships.customer_team.billing_customer` (object)
    A collection of users that can interact with the Aryeo platform. Permissions and properties are determined based on the group's type which can be creator, agent, or brokerage.

  - `customer_team_memberships.customer_team.billing_customer_pays_externally` (boolean)
    Indicates if the billing customer team membership pays externally.
    Example: true

  - `customer_team_memberships.customer_team.status` (string)
    The status of the customer group.
    Enum: "any_status", "active", "archived"

  - `customer_team_memberships.customer_team.is_archived` (boolean)
    Indicates if the customer group is archived.
    Example: true

  - `customer_team_memberships.customer_team.website` (string,null)
    The website URL of the customer group.
    Example: "https://www.aryeo.com"

  - `customer_team_memberships.customer_team.is_default` (boolean,null)
    Indicates if the customer group is the default customer group.
    Example: true

  - `customer_team_memberships.is_active` (boolean)
    Whether the customer team membership is active.
    Example: true

  - `customer_team_memberships.is_archived` (boolean)
    Whether the customer team membership is archived.
    Example: true

  - `customer_team_memberships.is_deleted` (boolean)
    Whether the customer team membership is deleted.
    Example: true

  - `customer_team_memberships.is_invited` (boolean)
    Whether the customer team membership is invited.
    Example: true

  - `customer_team_memberships.is_default` (boolean)
    Whether the customer team membership is the default.
    Example: true

  - `customer_team_memberships.created_at` (string,null)
    The date and time (ISO 8601 format) when the customer team membership was created.
    Example: "2025-04-01T05:59:59.999999Z"

  - `customer_team_memberships.customer_user` (object)
    A record of a customer on the Aryeo platform.

  - `customer_team_memberships.customer_user.name` (string,null)
    Name of the user.
    Example: "John"

  - `customer_team_memberships.customer_user.logo_url` (string,null)
    The logo URL of a user.
    Example: "https://picsum.photos/300"

  - `customer_team_memberships.customer_user.timezone` (string,null)
    The default timezone for the customer.
    Example: "America/New_York"

  - `customer_team_memberships.customer_user.customer_team_memberships` (array)

  - `customer_team_memberships.customer_user.created_at` (string)
    The date and time (ISO 8601 format) when the customer record was created.
    Example: "2021-06-30T20:30:00Z"

  - `customer_team_memberships.customer_user.is_visible` (boolean,null)
    Indicates if the customer is visible.
    Example: true

  - `customer_team_memberships.customer_user.order_index` (integer,null)
    The order index of the customer.
    Example: 1

  - `customer_team_memberships.customer_user.verification_status` (string)
    The verification status of the customer.
    Enum: "verified", "unverified", "new", "sso"

  - `customer_team_memberships.customer_user.credit_balance_amount` (number,null)
    The credit balance amount of the customer.
    Example: 100

  - `customer_team_memberships.customer_user.total_balance_amount` (number,null)
    The total balance amount of the customer.
    Example: 100

  - `customer_team_memberships.customer_user.is_showingtimeplus_user` (boolean)
    Whether the customer is a ShowingTime+ user.
    Example: true

  - `customer_team_memberships.customer_user.full_name` (string)
    The full name of the customer.
    Example: "John Doe"

  - `customer_team_memberships.customer_user.first_name` (string)
    The first name of the customer.
    Example: "John"

  - `customer_team_memberships.customer_user.last_name` (string)
    The last name of the customer.
    Example: "Doe"

  - `customer_team_memberships.customer_user.phone_number` (string,null)
    The phone number of the customer.
    Example: "1234567890"

  - `customer_team_memberships.customer_user.profile_link` (string,null)
    The profile link of the customer.
    Example: "https://picsum.photos/300"

  - `customer_team_memberships.customer_user.internal_notes` (string,null)
    The internal notes of the customer.
    Example: "John Doe is a customer."

  - `customer_team_memberships.customer_user.agent_company_name` (string,null)
    The agent company name of the customer.
    Example: "John Doe Real Estate"

  - `customer_team_memberships.customer_user.agent_license_number` (string,null)
    The agent license number of the customer.
    Example: "1234567890"

  - `customer_team_memberships.customer_user.is_blocked_from_ordering` (boolean)
    Whether the customer is blocked from ordering.
    Example: true

  - `customer_team_memberships.customer_user.has_restricted_photographers` (boolean)
    Whether the customer is restricted from booking appointments with certain photographers.
    Example: true

  - `customer_team_memberships.customer_user.default_lock_downloads_before_payment` (boolean,null)
    Whether the customer has locked media downloads before payment as the default download setting.
    Example: true

  - `customer_team_memberships.customer_user.default_allows_access_to_marketing_material` (boolean,null)
    Whether the customer has access to the marketing material builder.
    Example: true

  - `customer_team_memberships.customer_user.avalara_customer_code` (string,null)
    The Avalara customer code of the customer.
    Example: "1234567890"

  - `customer_team_memberships.customer_user.quickbooks_customer_id` (string,null)
    The Quickbooks customer ID of the customer.
    Example: "1234567890"

  - `customer_team_memberships.listing_delivery_notification_enabled` (boolean)
    Whether the customer team membership has listing delivery notifications enabled.
    Example: true

  - `customer_team_memberships.is_showingtimeplus_workspace_membership` (boolean)
    Whether the customer team membership is a ShowingTime workspace membership.
    Example: true

  - `customer_team_memberships.is_visible` (boolean,null)
    Whether the customer team membership is visible.
    Example: true

  - `customer_team_memberships.order_index` (integer,null)
    The order index of the customer team membership.
    Example: 1

## Response 404 fields (application/json):

  - `status` (string, required)
    What was the state of the request?
    Example: "error"

  - `message` (string, required)
    The error message.
    Example: "{ApiError message.}"

  - `code` (integer,null)
    A numeric code corresponding to the error.
    Example: 404

## Response 422 fields (application/json):

  - `status` (string, required)
    What was the state of the request?
    Example: "fail"

## Response 500 fields (application/json):

  - `status` (string, required)
    What was the state of the request?
    Example: "error"

  - `message` (string, required)
    The error message.
    Example: "{ApiError message.}"

  - `code` (integer,null)
    A numeric code corresponding to the error.
    Example: 500