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.
Authorization
bearerAuth API key in the Authorization: Bearer <key> header.
Keys are created in the SMAO dashboard (Settings → API Keys).
In: header
Path Parameters
^[a-f0-9]{24}$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Partial update — include only the fields you want to change.
group_id cannot be changed via this endpoint.
Partial update — include only the fields you want to change.
group_id cannot be changed via this endpoint.
1 <= propertiesResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/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" }}