Update a forwarding
Partial update - only included fields are changed. group_id cannot
be changed via this endpoint; create a new forwarding in the target
group instead. When changing to destination_type: phone, also send a
non-empty phone_number; the validator permits it to be omitted or
empty, but the resulting target cannot be dialed. Returns 409
conflict when the stored forwarding forbids the change: a field the
employee record owns on a forwarding with identity_source: employee,
or a non-empty dtmf_sequence on a forwarding with warm transfer
enabled in the dashboard.
bearerAuthAuthorizationBearer <token>API key in the Authorization: Bearer <key> header.
Keys are created in the Hallolara dashboard (Settings → API Keys).
forwarding_id*string^[a-f0-9]{24}$application/json- body
Partial update - include only the fields you want to change.
group_id cannot be changed via this endpoint.
1 <= propertiestype?string"personal""queue""fallback"destination_type?string"phone""sip""sip_refer"gender?stringSend an empty string to clear the value; omit the property to preserve it.
job_title?stringfirst_name?stringlast_name?stringemail?stringcompetence?stringactivation_keywords?array<>items <= 50phone_number?stringsip_uri?string^sip:sip_username?|Optional SIP auth username. Only allowed when the effective destination_type is sip.
sip_password?|Optional SIP auth password. Only allowed when the effective destination_type is sip; never returned in responses.
passwordsip_refer_target?stringSIP REFER target. Required when changing destination_type to sip_refer.
^\S+$1 <= lengthactive?booleanfallback?booleantimeout?integer10 <= value <= 60dtmf_sequence?array<>Updated forwarding.
application/json- response
data?curl -X PATCH 'https://api.hallolara.ai/api/v1/forwardings/65f8fa6f1a9d8e0012ab34cd' \ -H 'Content-Type: application/json' \ -d '{ "timeout": 30}'{ "data": { "id": "string", "group_id": "string", "group_name": "string", "type": "personal", "gender": "string", "job_title": "string", "first_name": "string", "last_name": "string", "email": "string", "competence": "string", "activation_keywords": [ "string" ], "destination_type": "phone", "phone_number": "string", "sip_uri": "string", "sip_username": "string", "sip_refer_target": "string", "has_sip_credentials": true, "identity_source": "employee", "active": true, "fallback": false, "timeout": 30, "dtmf_sequence": [ { "action": "pause", "duration": 0, "digits": "string" } ], "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }}