# Create customer team tag.

Create customer team tag.

Endpoint: POST /customer-teams/{customer_team_id}/tags
Version: 1.0.0
Security: Token

## Path parameters:

  - `customer_team_id` (string, required)
    The ID of a customer team. UUID Version 4.
    Example: "00000000-0000-4000-8000-000000000000"

## Request fields (application/json):

  - `tag_id` (string,null)
    The ID of the tag to add to the customer team.
    Example: "00000000-0000-4000-8000-000000000000"

  - `tag` (object,null)
    The tag to add to the customer team.

  - `tag.name` (string, required)
    The name of the tag.
    Example: "Photography"

  - `tag.color` (string, required)
    The color of the tag.
    Example: "#FFFFFF"

  - `tag.type` (string)
    The type of the tag.
    Enum: "order", "customer_team", "product", "order_form", "virtual_staging_ai"

## Response 200 fields (application/json):

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

  - `data` (object)
    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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  - `data.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.

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

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

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

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

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

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

  - `data.billing_customer.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"

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

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

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

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

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

  - `data.billing_customer.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_event_title_modified", "custom_field_uploads", "customer_teams_order_form_landing_page_override", "customer_teams_product_preselect", "customer_teams_external_payments", "customer_portal_mobile_app_automated_screenshots", "database_external_calendar_events", "default_reschedule_toggle_false", "idp_migration_in_progress", "listings_new_creation_flow", "min_hour_targets", "max_travel_distance", "order_form_categories", "require_photographer_confirmations", "showcase_order_form_visibility_designations", "team_member_restrictions", "team_member_hide_customer_pii", "virtual_staging_ai_v2", "virtual_staging_ai_v2_pricing", "virtuals1_custom_sms_notification_messages", "quickbooks_app", "webhooks", "zillow_3d_home", "zillow_streeteasy", "zillow_rentals"

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

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

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

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

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

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

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

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

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

  - `data.billing_customer.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"

  - `data.billing_customer.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"

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

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

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

  - `data.billing_customer.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"

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

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

  - `data.billing_customer.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"

  - `data.billing_customer.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

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

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

  - `data.billing_customer.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

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

  - `data.billing_customer.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.

  - `data.billing_customer.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.

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

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

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

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

  - `data.billing_customer.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"

  - `data.billing_customer.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

  - `data.billing_customer.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

  - `data.billing_customer.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

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

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

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

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

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

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

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

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

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

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

  - `data.billing_customer.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"

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

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

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

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

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

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

  - `data.billing_customer.owner.verification_status` (string)
    The verification status of the user.
    Enum: "verified", "unverified", "new", "sso"

  - `data.billing_customer.owner.password_expiration_days` (integer,null)
    The number of days until the user's password expires.
    Example: 30

  - `data.billing_customer.owner.timezone` (string,null)
    The default timezone for the user.
    Example: "America/New_York"

  - `data.billing_customer.owner.created_at` (string,null)
    The date and time (ISO 8601 format) when the user was created.
    Example: "2021-06-30T20:30:00Z"

  - `data.billing_customer.users` (array,null)
    The Aryeo users associated with this group.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  - `data.tags` (array)

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

  - `data.tags.name` (string, required)
    The name of the tag.
    Example: "Photography"

  - `data.tags.slug` (string, required)
    The slug of the tag.
    Example: "photography"

  - `data.tags.color` (string, required)
    The background color of the tag.
    Example: "#8BC34A"

  - `data.tags.font_color` (string, required)
    The font color of the tag.
    Example: "#FFFFFF"

  - `data.tags.type` (string)
    The type of the tag.
    Enum: "order", "customer_team", "product", "order_form", "virtual_staging_ai"

  - `timestamp` (string,null)
    The request timestamp (ISO 8601).
    Example: "2021-06-30T20:30:00Z"

## 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