ROroarkhq
Call

Update the properties of a call

Changed on

Add, overwrite or remove custom properties on an already-existing call. Use this for data that becomes available after the call was created, e.g. an outcome your system validates a few minutes later. Merge semantics: a value adds or overwrites the property, null removes it, and properties left out are untouched. The patch is applied whole or not at all: a property Roark sets itself, or a value whose type differs from the type the project already stores that property as, rejects the request with a 400 and nothing is written. A 409 means another request created one of the properties with a different value type at the same moment; nothing was written. Optionally pass metrics to (re)score metrics over the updated properties, which triggers a billed metric collection job and requires the metric:create permission.

patch/v1/call/{callId}/properties

Request

  • Base URL
    https://api.roark.ai
  • URL
    https://api.roark.ai/v1/call/{callId}/properties
  • Auth
    HTTP bearer

Path parameters

callIdstring uuid required

Request body

propertiesobject required

Properties to change on the call. A string, number or boolean value adds the property or overwrites it; null removes it. Properties left out are untouched. Keys are stored in snake_case, as on POST /v1/call. A property keeps the value type it was first stored with in the project, so a value of another type is rejected. Properties Roark sets itself (direction, duration_seconds, agent_id, ...) can't be changed. Max 100 per request.

Example request

{
  "properties": {
    "partner_outcome": "apr_returned",
    "delivered_apr": "21.99"
  }
}

Response

Properties updated on the call

Changes