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

# Update SMS configuration



## OpenAPI

````yaml post /cleartalk-sms/update-sms-configuration
openapi: 3.0.0
info:
  title: ClearTalk API
  description: The ClearTalk API Documentation
  version: '1.0'
  contact:
    name: Developer Support
    email: devsupport@cleartalk.ai
servers:
  - url: https://api.cleartalk.ai
    description: ClearTalk AI API Server
security: []
tags: []
paths:
  /cleartalk-sms/update-sms-configuration:
    post:
      tags:
        - cleartalk SMS
      summary: Update SMS configuration
      operationId: cleartalkSmsController_updateSmsConfiguration
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSmsConfigurationDto'
      responses:
        '201':
          description: ''
      security:
        - apiKey: []
        - apiKey: []
components:
  schemas:
    UpdateSmsConfigurationDto:
      type: object
      properties:
        phone_number:
          type: string
          description: >-
            The E.164 formatted phone number to update (must belong to the
            authenticated user)
          example: '+1234567890'
        webhook:
          type: string
          description: >-
            When the agent sends a response, we'll send the message details in a
            POST request to the URL you specify here, along with chat history
          example: https://your-webhook-url.com/sms-callback
        webhook_trigger_on:
          type: string
          description: >-
            When to trigger the webhook: on each message or only on final
            disposition
          example: final_disposition
          enum:
            - each_message
            - final_disposition
        agent_name:
          type: string
          description: The name of the agent
          example: John Doe
        request_data:
          description: >-
            Request data fields are available to the AI agent during the call
            when referenced in the associated pathway or task
          example:
            - key: value
              customer_id: '12345'
          type: array
          items:
            type: string
        time_out:
          type: number
          description: >-
            Maximum time to wait for a response (in seconds). Follow-up times
            must be less than this value.
          example: 300
        messaging_service_sid:
          type: string
          description: Twilio Messaging Service SID, if set
          example: MG1234567890abcdef1234567890abcdef
        objective:
          type: string
          description: Assistant system prompt or conversational goal
          example: >-
            You are a helpful customer service agent. Your goal is to assist
            customers with their inquiries.
        tools:
          description: List of tools available to the assistant
          example:
            - name: search
              description: Search for information
          type: array
          items:
            type: string
        temperature:
          type: number
          description: The model's temperature setting, controlling creativity
          example: 0.7
        pathway_id:
          type: string
          description: The ID of the linked conversational pathway (if any)
          example: path_1234567890abcdef
        pathway_version:
          type: string
          description: The specific version of the pathway to use
          example: v1.0.0
        start_node_id:
          type: string
          description: Entry point node ID for the pathway
          example: node_1234567890abcdef
        follow_up_config:
          description: Follow-up configuration for the SMS agent
          example:
            enable_follow_ups: true
            enable_smart_follow_ups: true
            repeat_final_follow_up: false
            follow_up_schedule:
              - time: 5
                unit: minutes
                repeat_forever: false
            extra_follow_up_prompt: Please respond to continue our conversation
          allOf:
            - $ref: '#/components/schemas/FollowUpConfigDto'
      required:
        - phone_number
        - webhook
        - agent_name
        - request_data
        - time_out
        - messaging_service_sid
        - objective
        - tools
        - temperature
        - pathway_id
        - pathway_version
        - start_node_id
    FollowUpConfigDto:
      type: object
      properties:
        enable_follow_ups:
          type: boolean
          description: Enable or disable follow-ups
          example: true
        enable_smart_follow_ups:
          type: boolean
          description: Enable or disable smart follow-ups
          example: true
        repeat_final_follow_up:
          type: boolean
          description: Repeat the final follow-up if there is no response
          example: false
        follow_up_schedule:
          description: Array of follow-up schedules
          type: array
          items:
            $ref: '#/components/schemas/FollowUpScheduleDto'
        extra_follow_up_prompt:
          type: string
          description: Extra prompt for follow-ups
          example: Please respond to continue the conversation
      required:
        - enable_follow_ups
        - enable_smart_follow_ups
        - repeat_final_follow_up
    FollowUpScheduleDto:
      type: object
      properties:
        time:
          type: number
          description: Time value for the follow-up interval
          example: 5
        unit:
          type: string
          description: Time unit for the follow-up interval
          example: minutes
          enum:
            - minutes
            - hours
            - days
      required:
        - time
        - unit
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: API Key for authentication

````