> ## Documentation Index
> Fetch the complete documentation index at: https://segmentflow.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Assign a template to a template group



## OpenAPI

````yaml /api-reference/openapi.json put /api/v1/templates/{id}/template-group
openapi: 3.0.3
info:
  title: SegmentFlow.ai API
  description: Unified SegmentFlow.ai API documentation
  version: 1.0.0
servers:
  - url: http://localhost:3001
    description: Local development
  - url: https://api-staging.segmentflow.ai
    description: Staging
  - url: https://api.segmentflow.ai
    description: Production
security:
  - apiKeyAuth: []
tags:
  - name: Profiles
    description: Profiles (Contacts)
  - name: Events
    description: Server-side business event tracking
  - name: Assets
    description: Assets
  - name: BackgroundJobs
    description: Background job progress
  - name: Brand-Kit
    description: Brand kits
  - name: Catalog-Products
    description: Catalog products
  - name: Templates
    description: Templates
  - name: Broadcasts
    description: Broadcasts
  - name: Segments
    description: Segments
  - name: Subscription-Groups
    description: Subscription groups
  - name: Privacy-Requests
    description: Privacy requests (GDPR data exports and erasures)
  - name: Journeys
    description: Journeys
  - name: Emails
    description: Email sends
paths:
  /api/v1/templates/{id}/template-group:
    put:
      tags:
        - Templates
      summary: Assign a template to a template group
      operationId: Templates_Templates_AssignTemplateGroup
      parameters:
        - schema:
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
          in: path
          name: id
          required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                assignment:
                  nullable: true
                  type: object
                  properties:
                    templateGroupId:
                      type: string
                      format: uuid
                      pattern: >-
                        ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                    locale:
                      type: string
                      minLength: 2
                      maxLength: 35
                  required:
                    - templateGroupId
                    - locale
              required:
                - assignment
        required: true
      responses:
        '200':
          description: >-
            Reusable locale-to-Template map used to seed localized drafts. Not
            editable send-time content.
          content:
            application/json:
              schema:
                nullable: true
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    pattern: >-
                      ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                  organizationId:
                    type: string
                    format: uuid
                    pattern: >-
                      ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                  name:
                    type: string
                  key:
                    nullable: true
                    type: string
                  defaultLocale:
                    type: string
                  fallbackMode:
                    type: string
                    enum:
                      - UseGroupDefault
                      - UseOrganizationDefault
                      - SkipRecipient
                  mappingRevision:
                    type: integer
                    minimum: 0
                    exclusiveMinimum: true
                    maximum: 9007199254740991
                  description:
                    nullable: true
                    type: string
                  source:
                    nullable: true
                    type: string
                  generationConfigurationStatus:
                    type: string
                    enum:
                      - configured
                      - required
                  purpose:
                    nullable: true
                    type: string
                    enum:
                      - General
                      - Newsletter
                      - Promotional
                      - Transactional
                      - LeadMagnetDelivery
                  mappings:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          pattern: >-
                            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                        locale:
                          type: string
                        isDefault:
                          type: boolean
                        templateId:
                          type: string
                          format: uuid
                          pattern: >-
                            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                        templateName:
                          type: string
                        generationStatus:
                          type: string
                          enum:
                            - pending
                            - generating
                            - ready
                            - failed
                        generationError:
                          nullable: true
                          type: string
                        templateLanguage:
                          type: string
                        templatePurpose:
                          type: string
                          enum:
                            - General
                            - Newsletter
                            - Promotional
                            - Transactional
                            - LeadMagnetDelivery
                        templateStatus:
                          $ref: '#/components/schemas/TemplateStatus'
                        templateIsComplete:
                          type: boolean
                        templateAuthoring:
                          type: object
                          properties:
                            version:
                              type: string
                              enum:
                                - template-authoring.v2
                            mode:
                              nullable: true
                              type: string
                              enum:
                                - manual_message_document
                                - automated_email_spec
                            modeSource:
                              type: string
                              enum:
                                - declared
                                - inferred
                                - unknown
                            label:
                              type: string
                              enum:
                                - Manual editor
                                - Autopilot design
                                - Unknown
                            manualMessageDocument:
                              type: object
                              properties:
                                compatible:
                                  type: boolean
                                reasons:
                                  type: array
                                  items:
                                    type: string
                                    enum:
                                      - template_archived
                                      - template_deleted
                                      - unsupported_template_type
                                      - unsupported_resource_type
                                      - unsupported_purpose
                                      - missing_definition
                                      - missing_authoring_mode
                                      - unsupported_authoring_mode
                                      - authoring_mode_mismatch
                                      - missing_spec_version
                                      - invalid_email_spec
                                      - malformed_body
                                      - missing_body_host
                                      - missing_editor_body
                                      - ambiguous_editor_body
                                      - invalid_editor_body_ref
                                      - editor_body_must_be_leaf
                                      - editor_body_present
                                      - not_extractable
                                      - missing_required_shell
                                      - missing_reusable_layout_blocks
                                      - brandkit_resolution_failed
                                      - not_ready_to_send
                                      - section_design
                              required:
                                - compatible
                                - reasons
                              additionalProperties: false
                            manualBroadcast:
                              type: object
                              properties:
                                selectable:
                                  type: boolean
                                reasons:
                                  type: array
                                  items:
                                    type: string
                                    enum:
                                      - template_archived
                                      - template_deleted
                                      - unsupported_template_type
                                      - unsupported_resource_type
                                      - unsupported_purpose
                                      - missing_definition
                                      - missing_authoring_mode
                                      - unsupported_authoring_mode
                                      - authoring_mode_mismatch
                                      - missing_spec_version
                                      - invalid_email_spec
                                      - malformed_body
                                      - missing_body_host
                                      - missing_editor_body
                                      - ambiguous_editor_body
                                      - invalid_editor_body_ref
                                      - editor_body_must_be_leaf
                                      - editor_body_present
                                      - not_extractable
                                      - missing_required_shell
                                      - missing_reusable_layout_blocks
                                      - brandkit_resolution_failed
                                      - not_ready_to_send
                                      - section_design
                              required:
                                - selectable
                                - reasons
                              additionalProperties: false
                            manualNewsletter:
                              type: object
                              properties:
                                selectable:
                                  type: boolean
                                reasons:
                                  type: array
                                  items:
                                    type: string
                                    enum:
                                      - template_archived
                                      - template_deleted
                                      - unsupported_template_type
                                      - unsupported_resource_type
                                      - unsupported_purpose
                                      - missing_definition
                                      - missing_authoring_mode
                                      - unsupported_authoring_mode
                                      - authoring_mode_mismatch
                                      - missing_spec_version
                                      - invalid_email_spec
                                      - malformed_body
                                      - missing_body_host
                                      - missing_editor_body
                                      - ambiguous_editor_body
                                      - invalid_editor_body_ref
                                      - editor_body_must_be_leaf
                                      - editor_body_present
                                      - not_extractable
                                      - missing_required_shell
                                      - missing_reusable_layout_blocks
                                      - brandkit_resolution_failed
                                      - not_ready_to_send
                                      - section_design
                              required:
                                - selectable
                                - reasons
                              additionalProperties: false
                            automatedEmailSpec:
                              type: object
                              properties:
                                selectable:
                                  type: boolean
                                reasons:
                                  type: array
                                  items:
                                    type: string
                                    enum:
                                      - template_archived
                                      - template_deleted
                                      - unsupported_template_type
                                      - unsupported_resource_type
                                      - unsupported_purpose
                                      - missing_definition
                                      - missing_authoring_mode
                                      - unsupported_authoring_mode
                                      - authoring_mode_mismatch
                                      - missing_spec_version
                                      - invalid_email_spec
                                      - malformed_body
                                      - missing_body_host
                                      - missing_editor_body
                                      - ambiguous_editor_body
                                      - invalid_editor_body_ref
                                      - editor_body_must_be_leaf
                                      - editor_body_present
                                      - not_extractable
                                      - missing_required_shell
                                      - missing_reusable_layout_blocks
                                      - brandkit_resolution_failed
                                      - not_ready_to_send
                                      - section_design
                              required:
                                - selectable
                                - reasons
                              additionalProperties: false
                            defaultDesign:
                              type: object
                              properties:
                                selectable:
                                  type: boolean
                                reasons:
                                  type: array
                                  items:
                                    type: string
                                    enum:
                                      - template_archived
                                      - template_deleted
                                      - unsupported_template_type
                                      - unsupported_resource_type
                                      - unsupported_purpose
                                      - missing_definition
                                      - missing_authoring_mode
                                      - unsupported_authoring_mode
                                      - authoring_mode_mismatch
                                      - missing_spec_version
                                      - invalid_email_spec
                                      - malformed_body
                                      - missing_body_host
                                      - missing_editor_body
                                      - ambiguous_editor_body
                                      - invalid_editor_body_ref
                                      - editor_body_must_be_leaf
                                      - editor_body_present
                                      - not_extractable
                                      - missing_required_shell
                                      - missing_reusable_layout_blocks
                                      - brandkit_resolution_failed
                                      - not_ready_to_send
                                      - section_design
                              required:
                                - selectable
                                - reasons
                              additionalProperties: false
                          required:
                            - version
                            - mode
                            - modeSource
                            - label
                            - manualMessageDocument
                            - manualBroadcast
                            - manualNewsletter
                            - automatedEmailSpec
                            - defaultDesign
                          additionalProperties: false
                        languageOverrideApproved:
                          type: boolean
                      required:
                        - id
                        - locale
                        - isDefault
                        - templateId
                        - templateName
                        - templateLanguage
                        - templatePurpose
                        - templateStatus
                        - templateIsComplete
                        - templateAuthoring
                        - languageOverrideApproved
                      additionalProperties: false
                  createdAt:
                    $ref: '#/components/schemas/IsoDateTimeString'
                  updatedAt:
                    $ref: '#/components/schemas/IsoDateTimeString'
                required:
                  - id
                  - organizationId
                  - name
                  - key
                  - defaultLocale
                  - fallbackMode
                  - mappingRevision
                  - description
                  - source
                  - generationConfigurationStatus
                  - purpose
                  - mappings
                  - createdAt
                  - updatedAt
                additionalProperties: false
                description: >-
                  Reusable locale-to-Template map used to seed localized drafts.
                  Not editable send-time content.
                x-allowed-consumer-kinds:
                  - Broadcast
                  - JourneyMessageStep
                  - NewsletterBase
                x-disallowed-send-owners:
                  - NewsletterIssue
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded. Wait for `Retry-After` seconds, then retry.
          headers:
            Retry-After:
              schema:
                type: integer
              description: Seconds to wait before retrying.
            X-RateLimit-Limit:
              schema:
                type: integer
              description: Requests allowed in the current window.
            X-RateLimit-Remaining:
              schema:
                type: integer
              description: Requests left in the current window.
            X-RateLimit-Reset:
              schema:
                type: integer
              description: Seconds until the current window resets.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitedErrorResponse'
components:
  schemas:
    TemplateStatus:
      type: string
      enum:
        - Active
        - Archived
      description: Lifecycle status of a message template (Active or Archived)
    IsoDateTimeString:
      type: string
      format: date-time
      pattern: >-
        ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
    ErrorResponse:
      type: object
      properties:
        errorCode:
          description: >-
            Stable machine-readable error code. SDKs map this to typed exception
            classes.
          example: TEMPLATE_NAME_EXISTS
          allOf:
            - $ref: '#/components/schemas/SegmentflowErrorCode'
        message:
          type: string
          description: >-
            Human-readable error message. May change between releases; do not
            parse.
          example: Template name 'Hello' already exists in this organization.
        details:
          description: >-
            Optional structured detail. `issues` carries per-field validation
            problems; other keys are reserved.
          type: object
          properties:
            issues:
              type: array
              items:
                $ref: '#/components/schemas/ErrorIssue'
          additionalProperties:
            description: Any JSON value.
            nullable: true
      required:
        - errorCode
        - message
      additionalProperties: false
      description: 'Canonical error envelope (ADR-0008): `{ errorCode, message, details? }`.'
    RateLimitedErrorResponse:
      type: object
      properties:
        errorCode:
          type: string
          enum:
            - RATE_LIMITED
          description: The request was rejected by an API rate limit.
          example: RATE_LIMITED
        message:
          type: string
          description: >-
            Human-readable error message. May change between releases; do not
            parse.
          example: Rate limit exceeded. Retry after 12 seconds.
        details:
          type: object
          properties:
            retryAfterSeconds:
              type: integer
              minimum: 0
              maximum: 9007199254740991
              description: >-
                Seconds to wait before retrying. Matches the `Retry-After`
                response header.
              example: 12
          required:
            - retryAfterSeconds
          additionalProperties: false
          description: When the client may retry.
      required:
        - errorCode
        - message
        - details
      additionalProperties: false
      description: >-
        429 error envelope (ADR-0008) sent when an API rate limit rejects the
        request.
    SegmentflowErrorCode:
      type: string
      enum:
        - BAD_REQUEST
        - UNAUTHORIZED
        - FORBIDDEN
        - NOT_FOUND
        - CONFLICT
        - GONE
        - UNPROCESSABLE_ENTITY
        - PAYLOAD_TOO_LARGE
        - TOO_MANY_REQUESTS
        - VALIDATION_ERROR
        - RATE_LIMITED
        - INTERNAL_ERROR
        - NOT_IMPLEMENTED
        - SERVICE_UNAVAILABLE
        - DATABASE_ERROR
        - IDEMPOTENCY_KEY_TOO_LONG
        - IDEMPOTENCY_KEY_REUSED
        - IDEMPOTENCY_IN_FLIGHT
        - JOURNEY_NOT_FOUND
        - JOURNEY_WRONG_ENTRY_NODE
        - JOURNEY_MISSING_RECIPIENT_EMAIL
        - JOURNEY_MISSING_REQUIRED_VARIABLES
        - JOURNEY_RECIPIENT_ERASED
        - BROADCAST_NOT_FOUND
        - BROADCAST_SCHEDULING_NOT_IMPLEMENTED
        - BROADCAST_INVALID_STATE
        - BROADCAST_SEND_NOT_ALLOWED
        - PREPARED_SEND_NOT_FOUND
        - PREPARED_SEND_EXPIRED
        - PREPARED_SEND_CROSS_USER
        - PREPARED_SEND_CORRUPT
        - PREPARED_SEND_CONCURRENT_REDEEM
        - PREPARED_SEND_VALIDATION_FAILED
        - SEGMENT_COUNT_CHANGED
        - NAME_TAKEN
        - DRAFT_CHANGED
        - DASHBOARD_EDITOR_REQUIRED
        - TEMPLATE_NOT_FOUND
        - TEMPLATE_NAME_EXISTS
        - TEMPLATE_GROUP_NOT_FOUND
        - TEMPLATE_GROUP_IN_USE
        - PROFILE_NOT_FOUND
        - PROFILE_SUBSCRIPTION_GROUP_NOT_FOUND
        - PROFILE_TRAITS_WRITE_UNSUPPORTED
        - PROFILE_PROPERTY_VALUE_INVALID
        - PROFILE_PROPERTY_NOT_EDITABLE
        - BULK_OPERATION_NOT_UNDOABLE
        - ANALYSIS_ALREADY_USED
        - ANALYSIS_EXPIRED
        - IMPORT_PLAN_INVALID
        - MISSING_CREDENTIAL
        - INVALID_API_KEY
        - INVALID_OAUTH_TOKEN
        - AMBIGUOUS_CREDENTIAL
        - INSUFFICIENT_SCOPE
        - MULTIPLE_CREDENTIALS_PRESENT
        - BEARER_CREDENTIAL_REMOVED
        - SESSION_ROLE_INSUFFICIENT
        - API_KEY_SCOPE_INSUFFICIENT
        - BILLING_DISABLED
        - BILLING_NOT_CONFIGURED
        - EMAIL_NOT_VERIFIED
        - ORGANIZATION_SUSPENDED
        - AI_ALLOWANCE_EXHAUSTED
        - WARMING_REQUIRED
        - WARMING_CAPACITY_EXHAUSTED
        - WARMING_NOT_REQUIRED
      description: >-
        Stable machine-readable error code. SDK codegen maps these to typed
        exception classes.
    ErrorIssue:
      type: object
      properties:
        path:
          anyOf:
            - type: string
            - type: array
              items:
                anyOf:
                  - type: string
                  - type: number
          description: >-
            Where in the request the issue occurred. String for simple paths;
            array for nested paths.
          example: name
        code:
          type: string
          description: >-
            Stable, machine-readable kind of issue (e.g. 'required',
            'invalid_type').
          example: duplicate
        message:
          type: string
          description: Human-readable description of the issue.
          example: Template name already exists in this organization.
      required:
        - path
        - code
        - message
      additionalProperties: false
      description: A single validation issue inside an error response's `details.issues[]`.
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Unified API key for server-side SDK and API integrations

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.