{"_id":"59e215afcbbe970024b33940","project":"55c8cff571d7580d0063a5e5","version":{"_id":"57624356653c2d2200fec79c","__v":21,"project":"55c8cff571d7580d0063a5e5","createdAt":"2016-06-16T06:12:38.244Z","releaseDate":"2016-06-16T06:12:38.244Z","categories":["57624356653c2d2200fec79d","57624356653c2d2200fec79e","57624356653c2d2200fec79f","57624356653c2d2200fec7a0","57624356653c2d2200fec7a1","57624356653c2d2200fec7a2","57624356653c2d2200fec7a3","57624356653c2d2200fec7a4","57624356653c2d2200fec7a5","57624356653c2d2200fec7a6","57624356653c2d2200fec7a7","57624356653c2d2200fec7a8","57624356653c2d2200fec7a9","57624356653c2d2200fec7aa","5779ca1b99b40b0e005abb3a","5779d198aea88b0e00f63277","5797d3ab17ced017003c4be4","57ac170ef1cdae0e0053cdfc","57dbfc723ed3450e00dc9e6d","5804d12d16161c0f0077df9b","5841064b652e5b0f0015a7c8","588b5e5f2966b2230009cbf9","58a68ebf3239fa0f00857619","58c23c8b4922930f0050ac91","58fd1460809fc30f00f2ee07","5934eaf5328680002d77de6a","594bf91601cfe6000f40f4c5","595c4ed696b447001ba0cf6d","596524495cee50001575f5be","5970d4f1313162004dd303b5","59780fac24dbd1001a1fa057","59a8cfd3ead78a002d63cafe","59e0323d93da1f001c9ec170","5b0c16f2be9fcb0003e28222"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"4.0.0","version":"4"},"category":{"_id":"59e0323d93da1f001c9ec170","project":"55c8cff571d7580d0063a5e5","version":"57624356653c2d2200fec79c","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-10-13T03:25:49.733Z","from_sync":false,"order":16,"slug":"fax","title":"Account Fax"},"user":"56f99ab84d2b4f3400edb636","__v":5,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-10-14T13:48:31.685Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"patch","examples":{"codes":[{"code":"<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, array(\n    CURLOPT_URL => \"https://api.phone.com/v4/accounts/337171/sms/6ef4a99c1450c90503c36406b8f2682f811ce91e\",\n    CURLOPT_RETURNTRANSFER => true,\n    CURLOPT_ENCODING => \"\",\n    CURLOPT_MAXREDIRS => 10,\n    CURLOPT_TIMEOUT => 30,\n    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n    CURLOPT_CUSTOMREQUEST => \"PATCH\",\n    CURLOPT_POSTFIELDS => '{ \"is_new\" : true }',\n    CURLOPT_HTTPHEADER => array(\n        \"authorization: Bearer Your API Access Token\",\n        \"cache-control: no-cache\",\n        \"content-type: application/json\"\n    ),\n));\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n    echo \"cURL Error #:\" . $err;\n} else {\n    echo $response;\n}\n","language":"php"}]},"settings":"","results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n    \"id\": \"6ef4a99c1450c90503c36406b8f2682f811ce91e\",\n    \"from\": \"+17329910138\",\n    \"to\": [\n        {\n            \"number\": \"+17326830492\",\n            \"status\": \"received\",\n            \"id\": \"6ef4a99c1450c90503c36406b8f2682f811ce91e\",\n            \"sent_at\": 1492398940,\n            \"delivered_at\": 1492398940,\n            \"processor\": \"kannel2.san.phone.com\",\n            \"processor_profile\": \"bandwidth-1\"\n        }\n    ],\n    \"direction\": \"in\",\n    \"created_epoch\": 1492398940,\n    \"created_at\": \"2017-04-17T03:15:40+00:00\",\n    \"is_new\": true,\n    \"text\": \"Item patch SMS\",\n    \"extension\": {\n        \"id\": 709038,\n        \"voip_id\": 337171,\n        \"name\": \"Home Extension\",\n        \"extension\": 18\n    }\n}"}]},"auth":"required","params":[{"_id":"56f9c415338fbb2000ec3711","ref":"","in":"path","required":false,"desc":"Account ID","default":"","type":"int","name":"account_id"},{"_id":"56f9c415338fbb2000ec3710","ref":"","in":"path","required":false,"desc":"ID of Fax to be updated","default":"","type":"string","name":"fax"},{"_id":"5748b901cc54530e00dc4271","ref":"","in":"body","required":true,"desc":"Status of Fax","default":"","type":"boolean","name":"is_new"}],"url":"/accounts/:account_id/fax/:fax_id"},"isReference":false,"order":3,"body":"","excerpt":"Update the is_new parameter in a Fax record.  See [Account Fax](doc:account-fax) for more info on the properties.\n\nNote: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level Patch Fax API with the following definition:\n\nPATCH https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/fax/:fax_id","slug":"patch-account-fax","type":"endpoint","title":"Patch Fax Status"}

patchPatch Fax Status

Update the is_new parameter in a Fax record. See [Account Fax](doc:account-fax) for more info on the properties. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level Patch Fax API with the following definition: PATCH https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/fax/:fax_id

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

account_id:
integer
Account ID
fax:
string
ID of Fax to be updated

Body Params

is_new:
required
boolean
Status of Fax

Examples


Result Format


User Information

Try It Out

patch
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}