> ## Documentation Index > Fetch the complete documentation index at: https://docs.callrounded.com/llms.txt > Use this file to discover all available pages before exploring further. # Update call > Update a call with additional metadata. The call can be either a phone call or a web call. The response includes the updated call details. If override is True, existing metadata will be completely replaced with new metadata, including `None` values. ## OpenAPI ````yaml /api-reference-v1/openapi.json patch /v1/calls/{call_id} openapi: 3.1.0 info: title: Rounded API description: Rounded API version: 1.0.0 servers: - url: https://api.callrounded.com security: - ApiKeyHeader: [] paths: /v1/calls/{call_id}: patch: tags: - calls summary: Update call description: >- Update a call with additional metadata. The call can be either a phone call or a web call. The response includes the updated call details. If override is True, existing metadata will be completely replaced with new metadata, including `None` values. operationId: update_call_v1_calls__call_id__patch parameters: - name: call_id in: path required: true schema: type: string format: uuid title: Call Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CallUpdateApiRequest' responses: '200': description: Successfully updated call information content: application/json: schema: $ref: '#/components/schemas/CallGetApiResponse-Input' headers: ratelimit-limit: description: The number of requests allowed in the current rate limit period schema: type: integer ratelimit-remaining: description: >- The number of requests remaining in the current rate limit period schema: type: integer x-ratelimit-limit-minute: description: >- The number of requests allowed in the current minute window, if rate limit is set to minutes. schema: type: integer x-ratelimit-remaining-minute: description: >- The number of requests remaining in the current minute window, if rate limit is set to minutes. schema: type: integer x-ratelimit-limit-hour: description: >- The number of requests allowed in the current hour window, if rate limit is set to hourly. schema: type: integer x-ratelimit-remaining-hour: description: >- The number of requests remaining in the current hour window, if rate limit is set to hourly. schema: type: integer x-ratelimit-limit-: description: >- The number of requests allowed in the current window, where is the number of seconds, if rate limit is set to seconds. schema: type: integer x-ratelimit-remaining-: description: >- The number of requests remaining in the current window, where is the number of seconds, if rate limit is set to seconds. schema: type: integer '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ApiResponseError' example: error: message: Bad request type: api_error status: 400 '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ApiResponseError' examples: auth_error: summary: Error from the API Service value: message: Unauthorized type: auth_error status: 401 gateway_error: summary: Error from the API Gateway value: message: Unauthorized type: gateway_auth_error status: 401 '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ApiResponseError' example: error: message: Access forbidden type: api_error status: 403 '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ApiResponseError' example: error: message: The request endpoint does not exist type: http_error status: 404 '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/ApiResponseError' example: error: message: Invalid request body type: validation_error status: 422 details: - field: email message: Invalid email format '429': description: Rate Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/ApiResponseError' example: error: message: API rate limit exceeded type: gateway_rate_limit_error status: 429 '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ApiResponseError' example: error: message: An unexpected error occurred type: generic_error status: 500 components: schemas: CallUpdateApiRequest: properties: metadata: anyOf: - type: object - type: 'null' title: Metadata description: Additional metadata to associate with the call. examples: - source: marketing_campaign utm_medium: email override: anyOf: - type: boolean - type: 'null' title: Override description: >- If True, existing metadata will be completely replaced with new metadata. If False, existing metadata will be merged with new metadata. default: false type: object title: CallUpdateApiRequest description: Schema for updating a call with metadata. CallGetApiResponse-Input: properties: message: type: string title: Message description: Response message indicating the result of the operation. default: Call retrieved successfully data: anyOf: - $ref: '#/components/schemas/PhoneCallGetApiResponseData-Input' - $ref: '#/components/schemas/WebCallGetApiResponseData-Input' title: Data description: The call data retrieved. error: anyOf: - $ref: '#/components/schemas/ApiResponseError' - type: 'null' status: type: integer title: Status description: HTTP status code of the response. default: 200 type: object required: - data title: CallGetApiResponse ApiResponseError: properties: message: type: string title: Message type: type: string title: Type status: type: integer title: Status details: anyOf: - items: $ref: '#/components/schemas/ApiResponseErrorDetail' type: array - type: 'null' title: Details type: object required: - message - type - status title: ApiResponseError example: details: - field: email message: Invalid email format message: An error occurred while processing your request status: 400 type: generic_error PhoneCallGetApiResponseData-Input: properties: id: type: string title: Id description: Unique identifier for the call. examples: - 123e4567-e89b-12d3-a456-426614174000 organization_id: anyOf: - type: string - type: 'null' title: Organization Id description: ID of the organization the call belongs to. examples: - 123e4567-e89b-12d3-a456-426614174001 type: $ref: '#/components/schemas/CallType' description: Indicates this is a phone call. default: phone_call agent_id: anyOf: - type: string - type: 'null' title: Agent Id description: ID of the agent handling the call. examples: - 123e4567-e89b-12d3-a456-426614174002 status: $ref: '#/components/schemas/CallStatus' description: >- Current status of the call. Possible values: - `created` - Call has been created but not yet queued. - `queued` - Call is waiting to be processed. - `dequeued` - Call has been dequeued and is waiting to be initiated. - `initiated` - Call has been initiated but not yet connected. - `ringing` - Phone is ringing at the destination. - `connected` - Call has been answered and is connected. - `in_progress` - Call is actively in progress with conversation. - `completed` - Call has ended successfully. - `redirection_completed` - Call was redirected and completed. - `busy` - Destination was busy when called. - `no_answer` - Call was not answered by the destination (no human answer). - `canceled` - Call was canceled before connection. - `failed` - Call failed due to technical issues. examples: - created - queued - dequeued - initiated - ringing - connected - in_progress - completed - redirection_completed - busy - no_answer - canceled - failed metadata: anyOf: - type: object - type: 'null' title: Metadata description: >- Additional metadata associated with the call. If an error occurs while processing the call, the metadata will contain the error message. examples: - source: marketing_campaign utm_medium: email start_time: anyOf: - type: string format: date-time - type: 'null' title: Start Time description: Timestamp when the call started. examples: - '2023-06-15T14:30:00Z' end_time: anyOf: - type: string format: date-time - type: 'null' title: End Time description: Timestamp when the call ended. examples: - '2023-06-15T14:35:00Z' duration_seconds: anyOf: - type: integer - type: 'null' title: Duration Seconds description: Duration of the call in seconds. examples: - 300 redirect_duration_seconds: anyOf: - type: integer - type: 'null' title: Redirect Duration Seconds description: Duration of call redirection in seconds. examples: - 5 cost: anyOf: - type: number - type: 'null' title: Cost description: Estimation of the cost of the call in EUR. examples: - 0.15 transcript_string: anyOf: - type: string - type: 'null' title: Transcript String description: Plain text representation of the call transcript. examples: - |- Agent: Hello, how can I help you today? User: I'd like to check on my order status. transcript: anyOf: - items: anyOf: - $ref: >- #/components/schemas/TranscriptMessageContentApiResponseData - $ref: '#/components/schemas/TranscriptToolCallApiResponseData' - $ref: '#/components/schemas/TranscriptToolResponseApiResponseData' - $ref: '#/components/schemas/TranscriptTaskSwitchApiResponseData' type: array - type: 'null' title: Transcript description: >- Structured representation of the call transcript with messages and tool calls. variable_values: anyOf: - items: $ref: '#/components/schemas/VariableValueApiResponseData' type: array - type: 'null' title: Variable Values description: Values of variables collected during the call. post_call_answers: anyOf: - items: $ref: '#/components/schemas/PostCallAnswerForCallDetails-Input' type: array - type: 'null' title: Post Call Answers description: >- Post-call analysis including questions and answers collected after the call. Includes all active custom questions for the agent, even if not answered. Each item contains the question details and the answer (if provided), with different answer fields based on question type (text, number, boolean, or selected options). answer_type: anyOf: - $ref: '#/components/schemas/CallAnswerType' - type: string - type: 'null' title: Answer Type description: |- Type of answer received from the destination. Possible values: - `human` - Call was answered by a human. - `machine` - Call was answered by a machine. - `unknown` - Answer type could not be determined. examples: - human - machine - unknown from_number: type: string title: From Number description: Phone number that initiated the call. examples: - '+33912345678' to_number: type: string title: To Number description: Phone number that received the call. examples: - '+33612345678' direction: $ref: '#/components/schemas/CallDirection' description: Direction of the call (inbound or outbound) examples: - inbound - outbound recording_url: anyOf: - type: string - type: 'null' title: Recording Url description: >- If agent has enabled securing recording urls, this will be a signed URL of the call recording with 1 hour expiration time, otherwise it will be a non-expiring URL. Returns `null` if no recording exists or if recording failed. examples: - >- https://rounded-storage.s3.amazonaws.com/calls/test?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=TEST%2F20250401%2Feu-west-3%2Fs3%2Faws4_request&X-Amz-Date=20250401T163838Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=046d4f7da8a7f2343875872593cbaa94a7836c42e1fd669e91fc2af9cf2b43be secure_recording_url: type: boolean title: Secure Recording Url description: >- Whether the recording URL should expire or not, the value is determined by the agent's settings when the call was created. default: true examples: - true - false type: object required: - id - status - from_number - to_number - direction title: PhoneCallGetApiResponseData WebCallGetApiResponseData-Input: properties: id: type: string title: Id description: Unique identifier for the call. examples: - 123e4567-e89b-12d3-a456-426614174000 organization_id: anyOf: - type: string - type: 'null' title: Organization Id description: ID of the organization the call belongs to. examples: - 123e4567-e89b-12d3-a456-426614174001 type: $ref: '#/components/schemas/CallType' description: Indicates this is a web call. default: web_call agent_id: anyOf: - type: string - type: 'null' title: Agent Id description: ID of the agent handling the call. examples: - 123e4567-e89b-12d3-a456-426614174002 status: $ref: '#/components/schemas/CallStatus' description: >- Current status of the call. Possible values: - `created` - Call has been created but not yet queued. - `queued` - Call is waiting to be processed. - `dequeued` - Call has been dequeued and is waiting to be initiated. - `initiated` - Call has been initiated but not yet connected. - `ringing` - Phone is ringing at the destination. - `connected` - Call has been answered and is connected. - `in_progress` - Call is actively in progress with conversation. - `completed` - Call has ended successfully. - `redirection_completed` - Call was redirected and completed. - `busy` - Destination was busy when called. - `no_answer` - Call was not answered by the destination (no human answer). - `canceled` - Call was canceled before connection. - `failed` - Call failed due to technical issues. examples: - created - queued - dequeued - initiated - ringing - connected - in_progress - completed - redirection_completed - busy - no_answer - canceled - failed metadata: anyOf: - type: object - type: 'null' title: Metadata description: >- Additional metadata associated with the call. If an error occurs while processing the call, the metadata will contain the error message. examples: - source: marketing_campaign utm_medium: email start_time: anyOf: - type: string format: date-time - type: 'null' title: Start Time description: Timestamp when the call started. examples: - '2023-06-15T14:30:00Z' end_time: anyOf: - type: string format: date-time - type: 'null' title: End Time description: Timestamp when the call ended. examples: - '2023-06-15T14:35:00Z' duration_seconds: anyOf: - type: integer - type: 'null' title: Duration Seconds description: Duration of the call in seconds. examples: - 300 redirect_duration_seconds: anyOf: - type: integer - type: 'null' title: Redirect Duration Seconds description: Duration of call redirection in seconds. examples: - 5 cost: anyOf: - type: number - type: 'null' title: Cost description: Estimation of the cost of the call in EUR. examples: - 0.15 transcript_string: anyOf: - type: string - type: 'null' title: Transcript String description: Plain text representation of the call transcript. examples: - |- Agent: Hello, how can I help you today? User: I'd like to check on my order status. transcript: anyOf: - items: anyOf: - $ref: >- #/components/schemas/TranscriptMessageContentApiResponseData - $ref: '#/components/schemas/TranscriptToolCallApiResponseData' - $ref: '#/components/schemas/TranscriptToolResponseApiResponseData' - $ref: '#/components/schemas/TranscriptTaskSwitchApiResponseData' type: array - type: 'null' title: Transcript description: >- Structured representation of the call transcript with messages and tool calls. variable_values: anyOf: - items: $ref: '#/components/schemas/VariableValueApiResponseData' type: array - type: 'null' title: Variable Values description: Values of variables collected during the call. post_call_answers: anyOf: - items: $ref: '#/components/schemas/PostCallAnswerForCallDetails-Input' type: array - type: 'null' title: Post Call Answers description: >- Post-call analysis including questions and answers collected after the call. Includes all active custom questions for the agent, even if not answered. Each item contains the question details and the answer (if provided), with different answer fields based on question type (text, number, boolean, or selected options). answer_type: anyOf: - $ref: '#/components/schemas/CallAnswerType' - type: string - type: 'null' title: Answer Type description: |- Type of answer received from the destination. Possible values: - `human` - Call was answered by a human. - `machine` - Call was answered by a machine. - `unknown` - Answer type could not be determined. examples: - human - machine - unknown type: object required: - id - status title: WebCallGetApiResponseData ApiResponseErrorDetail: properties: field: anyOf: - type: string - type: 'null' title: Field message: type: string title: Message type: object required: - message title: ApiResponseErrorDetail CallType: type: string enum: - phone_call - web_call title: CallType CallStatus: type: string enum: - created - queued - dequeued - initiated - ringing - connected - in_progress - completed - redirection_completed - busy - no_answer - canceled - failed title: CallStatus TranscriptMessageContentApiResponseData: properties: role: $ref: '#/components/schemas/TranscriptRole' description: Role of the entity sending the message (user, agent, tool, etc.). examples: - user - agent - tool start_time: type: string format: date-time title: Start Time description: Timestamp when the message was created. examples: - '2023-06-15T14:31:23Z' content: type: string title: Content description: The actual text content of the message. examples: - Hello, how can I help you today? - I'd like to check on my order status. type: object required: - role - start_time - content title: Message Content description: Response schema for regular message content. TranscriptToolCallApiResponseData: properties: role: $ref: '#/components/schemas/TranscriptRole' description: Role of the entity sending the message (user, agent, tool, etc.). examples: - user - agent - tool start_time: type: string format: date-time title: Start Time description: Timestamp when the message was created. examples: - '2023-06-15T14:31:23Z' tool_calls: items: $ref: '#/components/schemas/ToolCallApiResponseData' type: array title: Tool Calls description: List of tool calls made during this interaction. type: object required: - role - start_time - tool_calls title: Tool Call description: Response schema for a transcript entry containing tool calls. TranscriptToolResponseApiResponseData: properties: role: $ref: '#/components/schemas/TranscriptRole' description: Role of the entity sending the message (user, agent, tool, etc.). examples: - user - agent - tool start_time: type: string format: date-time title: Start Time description: Timestamp when the message was created. examples: - '2023-06-15T14:31:23Z' content: anyOf: - type: string - type: 'null' title: Content description: Text content of the tool response, if applicable. examples: - 'Order ORD-12345 status: Shipped' - null tool_calls: items: type: object type: array title: Tool Calls examples: - [] type: object required: - role - start_time title: Tool Response description: Response schema for a transcript entry containing a tool response. TranscriptTaskSwitchApiResponseData: properties: role: $ref: '#/components/schemas/TranscriptRole' description: Role of the entity sending the message (user, agent, tool, etc.). examples: - user - agent - tool start_time: type: string format: date-time title: Start Time description: Timestamp when the message was created. examples: - '2023-06-15T14:31:23Z' content: type: string title: Content description: Text content of the task switch. examples: - Switched to task 'Check Order Status' type: object required: - role - start_time - content title: Task Switch description: Response schema for a transcript entry containing a task switch. VariableValueApiResponseData: properties: name: type: string title: Name description: Name of the variable. examples: - customer_name - order_id - shipping_address type: $ref: '#/components/schemas/VariableType' description: Data type of the variable. examples: - string - number - boolean value: anyOf: - type: string - type: 'null' title: Value description: The actual value of the variable as a string. examples: - John Doe - '12345' - 'true' timestamp: anyOf: - type: string format: date-time - type: 'null' title: Timestamp description: When the variable was last updated. examples: - '2023-06-15T14:33:12Z' type: object required: - name - type title: VariableValueApiResponseData description: |- API response schema for variable values. This schema is used in the call response. PostCallAnswerForCallDetails-Input: properties: id: type: string title: Id description: Unique identifier (answer ID if answered, otherwise question ID). examples: - 123e4567-e89b-12d3-a456-426614174000 question: $ref: '#/components/schemas/PostCallQuestionForCallDetails' description: The post-call question this answer relates to. answer_text: anyOf: - type: string - type: 'null' title: Answer Text description: Text answer for `text` type questions. examples: - The customer expressed satisfaction with the resolution. answer_number: anyOf: - type: number - type: 'null' title: Answer Number description: Numeric answer for `number` type questions. examples: - 8.5 - 10 - 3 answer_boolean: anyOf: - type: boolean - type: 'null' title: Answer Boolean description: Boolean answer for `boolean` type questions. examples: - true - false selected_options: items: $ref: '#/components/schemas/PostCallSelectedOptionForCallDetails' type: array title: Selected Options description: Selected options for `selector` or `multi_selector` type questions. has_answer: type: boolean title: Has Answer description: Whether this question has been answered for this call. examples: - true - false type: object required: - id - question - has_answer title: PostCallAnswerForCallDetails description: Post-call answer schema for call details API response. CallAnswerType: type: string enum: - human - machine - unknown title: CallAnswerType CallDirection: type: string enum: - inbound - outbound title: CallDirection TranscriptRole: type: string enum: - user - agent - tool - task_switch title: TranscriptRole ToolCallApiResponseData: properties: name: type: string title: Name description: Name of the tool being called. examples: - check_order_status - lookup_customer arguments: type: string title: Arguments description: Arguments passed to the tool. examples: - '{"order_id": "ORD-12345"}' - '{"customer_email": "user@example.com"}' tool_call_id: type: string title: Tool Call Id description: Unique identifier for this specific tool call. examples: - G3J5BX2JK type: object required: - name - arguments - tool_call_id title: ToolCallApiResponseData description: Response schema for a tool call. VariableType: type: string enum: - string - boolean - number - integer - array - datetime - json title: VariableType PostCallQuestionForCallDetails: properties: id: type: string title: Id description: Unique identifier for the question. examples: - 123e4567-e89b-12d3-a456-426614174000 name: type: string title: Name description: Short name/title of the question. examples: - Customer Satisfaction description: type: string title: Description description: The full question text or prompt used for analysis. examples: - How satisfied was the customer with the call outcome? question_type: $ref: '#/components/schemas/PostCallQuestionType' description: |- The type of answer expected for this question. Possible values: - `text` - Free-form text answer - `boolean` - Yes/No answer - `number` - Numeric answer - `selector` - Single choice from predefined options - `multi_selector` - Multiple choices from predefined options examples: - text - boolean - number - selector - multi_selector is_optional: type: boolean title: Is Optional description: Whether this question is optional or required. examples: - false - true question_origin: $ref: '#/components/schemas/PostCallQuestionOrigin' description: |- The origin of the question. Possible values: - `system` - Built-in system question - `custom` - User-defined custom question examples: - system - custom type: object required: - id - name - description - question_type - is_optional - question_origin title: PostCallQuestionForCallDetails description: Question schema for call details response. PostCallSelectedOptionForCallDetails: properties: option: $ref: '#/components/schemas/PostCallOptionForCallDetails' description: The selected option details. type: object required: - option title: PostCallSelectedOptionForCallDetails description: Selected option wrapper for call details response. PostCallQuestionType: type: string enum: - boolean - selector - multi_selector - text - number title: PostCallQuestionType PostCallQuestionOrigin: type: string enum: - system - custom title: PostCallQuestionOrigin PostCallOptionForCallDetails: properties: id: type: string title: Id description: Unique identifier for the option. examples: - 123e4567-e89b-12d3-a456-426614174000 value: type: string title: Value description: The text value of the option. examples: - Very Satisfied - Satisfied - Neutral type: object required: - id - value title: PostCallOptionForCallDetails description: Minimal option schema for call details response. securitySchemes: ApiKeyHeader: type: apiKey in: header name: X-Api-Key description: >- The API Key created in [Rounded Studio](https://app.callrounded.com). - You can create it by going to the "API Keys" settings of your profile. - Need help? You can email us at [team@callrounded.com](mailto:team@callrounded.com) or join our [Discord community](https://discord.gg/en537j5z75). ````