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.

PATCH /v1/calls/{call_id}

Update call

cURL

curl --request PATCH \
  --url https://api.callrounded.com/v1/calls/{call_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "metadata": {
    "source": "marketing_campaign",
    "utm_medium": "email"
  },
  "override": false
}
'

200

Example

{ "data": { "id": "<string>", "status": "created", "from_number": "<string>", "to_number": "<string>", "direction": "inbound", "organization_id": "123e4567-e89b-12d3-a456-426614174001", "type": "phone_call", "agent_id": "123e4567-e89b-12d3-a456-426614174002", "metadata": { "source": "marketing_campaign", "utm_medium": "email" }, "start_time": "2023-06-15T14:30:00Z", "end_time": "2023-06-15T14:35:00Z", "duration_seconds": 300, "redirect_duration_seconds": 5, "cost": 0.15, "transcript_string": "Agent: Hello, how can I help you today?\nUser: I'd like to check on my order status.", "transcript": [ { "role": "user", "start_time": "2023-11-07T05:31:56Z", "content": "<string>" } ], "variable_values": [ { "name": "<string>", "type": "string", "value": "John Doe", "timestamp": "2023-06-15T14:33:12Z" } ], "post_call_answers": [ { "id": "<string>", "question": { "id": "<string>", "name": "<string>", "description": "<string>", "question_type": "boolean", "is_optional": true, "question_origin": "system" }, "has_answer": true, "answer_text": "The customer expressed satisfaction with the resolution.", "answer_number": 8.5, "answer_boolean": true, "selected_options": [ { "option": { "id": "<string>", "value": "<string>" } } ] } ], "answer_type": "human", "recording_url": "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": true }, "message": "Call retrieved successfully", "error": { "details": [ { "field": "email", "message": "Invalid email format" } ], "message": "An error occurred while processing your request", "status": 400, "type": "generic_error" }, "status": 200 }

Authorizations

X-Api-Key · string · header · required

The API Key created in Rounded Studio.

• You can create it by going to the "API Keys" settings of your profile.
• Need help? You can email us at [e-mail] or join our Discord community.

Path Parameters

call_id · string<uuid> · required

Body

application/json

Schema for updating a call with metadata.

metadata · Metadata · object

Additional metadata to associate with the call.

Example:

{
  "source": "marketing_campaign",
  "utm_medium": "email"
}

override · boolean | null · default: false

If True, existing metadata will be completely replaced with new metadata. If False, existing metadata will be merged with new metadata.

Response

200

application/json

Successfully updated call information

data · PhoneCallGetApiResponseData · object · required

The call data retrieved.

PhoneCallGetApiResponseData

WebCallGetApiResponseData

Show child attributes

message · string · default: Call retrieved successfully

Response message indicating the result of the operation.

error · ApiResponseError · object

Show child attributes

Example:

{
  "details": [
    {
      "field": "email",
      "message": "Invalid email format"
    }
  ],
  "message": "An error occurred while processing your request",
  "status": 400,
  "type": "generic_error"
}

status · integer · default: 200

HTTP status code of the response.