Update Phone Delivery Settings (Twilio)

PUT {{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings/{{phoneDeliverySettingsID}}

The PUT {{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings/{{phoneDeliverySettingsID}} endpoint updates the specified custom Twilio phone delivery settings in a specified environment. Note the value of CUSTOM_TWILIO assignmed to provider in the request body.

Prerequisites

Refer to Notifications and Phone Delivery Settings for important overview information.

Request Model

Property Type Required?

Property	Type	Required?
`id`	String	Required
`numbers`	Array	Required
`provider`	String	Required
`sid`	String	Required

id

String

Required

numbers

Array

Required

provider

String

Required

sid

String

Required

Refer to the Phone delivery settings data models for full property descriptions.

Headers

Authorization Bearer {{accessToken}}

Content-Type application/json

Body

raw ( application/json )

{
  "id": "updatedTwilioPhoneDeliverySettingsId",
  "sid": "updatedSid",
  "provider": "CUSTOM_TWILIO",
  "numbers": [
    {
      "type": "SHORT_CODE",
      "capabilities": [
        "SMS"
      ],
      "selected": true,
      "available": true,
      "number": "894546"
    },
    {
      "type": "SHORT_CODE",
      "capabilities": [
        "SMS"
      ],
      "selected": false,
      "available": true,
      "number": "894545",
      "supportedCountries": ["CA"]
    },
    {
      "type": "TOLL_FREE",
      "capabilities": [
        "SMS",
        "VOICE"
      ],
      "selected": true,
      "available": true,
      "number": "+18544440099",
      "supportedCountries": ["US", "CA"]
    },
    {
      "type": "TOLL_FREE",
      "capabilities": [
        "SMS",
        "VOICE"
      ],
      "selected": false,
      "available": true,
      "number": "+18544440098",
      "supportedCountries": ["ALL"]
    },
    {
      "type": "PHONE_NUMBER",
      "capabilities": [
        "SMS",
        "VOICE"
      ],
      "selected": true,
      "available": true,
      "number": "+172544440091"
    },
    {
      "type": "PHONE_NUMBER",
      "capabilities": [
        "SMS",
        "VOICE"
      ],
      "selected": true,
      "available": true,
      "number": "+972544440099"
    }
  ]
}

Example Request

curl --location --globoff --request PUT '{{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings/{{phoneDeliverySettingsID}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
  "id": "updatedTwilioPhoneDeliverySettingsId",
  "sid": "updatedSid",
  "provider": "CUSTOM_TWILIO",
  "numbers": [
    {
      "type": "SHORT_CODE",
      "capabilities": [
        "SMS"
      ],
      "selected": true,
      "available": true,
      "number": "894546"
    },
    {
      "type": "SHORT_CODE",
      "capabilities": [
        "SMS"
      ],
      "selected": false,
      "available": true,
      "number": "894545",
      "supportedCountries": ["CA"]
    },
    {
      "type": "TOLL_FREE",
      "capabilities": [
        "SMS",
        "VOICE"
      ],
      "selected": true,
      "available": true,
      "number": "+18544440099",
      "supportedCountries": ["US", "CA"]
    },
    {
      "type": "TOLL_FREE",
      "capabilities": [
        "SMS",
        "VOICE"
      ],
      "selected": false,
      "available": true,
      "number": "+18544440098",
      "supportedCountries": ["ALL"]
    },
    {
      "type": "PHONE_NUMBER",
      "capabilities": [
        "SMS",
        "VOICE"
      ],
      "selected": true,
      "available": true,
      "number": "+172544440091"
    },
    {
      "type": "PHONE_NUMBER",
      "capabilities": [
        "SMS",
        "VOICE"
      ],
      "selected": true,
      "available": true,
      "number": "+972544440099"
    }
  ]
}'

var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings/{{phoneDeliverySettingsID}}")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Put);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@"  ""id"": ""updatedTwilioPhoneDeliverySettingsId""," + "\n" +
@"  ""sid"": ""updatedSid""," + "\n" +
@"  ""provider"": ""CUSTOM_TWILIO""," + "\n" +
@"  ""numbers"": [" + "\n" +
@"    {" + "\n" +
@"      ""type"": ""SHORT_CODE""," + "\n" +
@"      ""capabilities"": [" + "\n" +
@"        ""SMS""" + "\n" +
@"      ]," + "\n" +
@"      ""selected"": true," + "\n" +
@"      ""available"": true," + "\n" +
@"      ""number"": ""894546""" + "\n" +
@"    }," + "\n" +
@"    {" + "\n" +
@"      ""type"": ""SHORT_CODE""," + "\n" +
@"      ""capabilities"": [" + "\n" +
@"        ""SMS""" + "\n" +
@"      ]," + "\n" +
@"      ""selected"": false," + "\n" +
@"      ""available"": true," + "\n" +
@"      ""number"": ""894545""," + "\n" +
@"      ""supportedCountries"": [""CA""]" + "\n" +
@"    }," + "\n" +
@"    {" + "\n" +
@"      ""type"": ""TOLL_FREE""," + "\n" +
@"      ""capabilities"": [" + "\n" +
@"        ""SMS""," + "\n" +
@"        ""VOICE""" + "\n" +
@"      ]," + "\n" +
@"      ""selected"": true," + "\n" +
@"      ""available"": true," + "\n" +
@"      ""number"": ""+18544440099""," + "\n" +
@"      ""supportedCountries"": [""US"", ""CA""]" + "\n" +
@"    }," + "\n" +
@"    {" + "\n" +
@"      ""type"": ""TOLL_FREE""," + "\n" +
@"      ""capabilities"": [" + "\n" +
@"        ""SMS""," + "\n" +
@"        ""VOICE""" + "\n" +
@"      ]," + "\n" +
@"      ""selected"": false," + "\n" +
@"      ""available"": true," + "\n" +
@"      ""number"": ""+18544440098""," + "\n" +
@"      ""supportedCountries"": [""ALL""]" + "\n" +
@"    }," + "\n" +
@"    {" + "\n" +
@"      ""type"": ""PHONE_NUMBER""," + "\n" +
@"      ""capabilities"": [" + "\n" +
@"        ""SMS""," + "\n" +
@"        ""VOICE""" + "\n" +
@"      ]," + "\n" +
@"      ""selected"": true," + "\n" +
@"      ""available"": true," + "\n" +
@"      ""number"": ""+172544440091""" + "\n" +
@"    }," + "\n" +
@"    {" + "\n" +
@"      ""type"": ""PHONE_NUMBER""," + "\n" +
@"      ""capabilities"": [" + "\n" +
@"        ""SMS""," + "\n" +
@"        ""VOICE""" + "\n" +
@"      ]," + "\n" +
@"      ""selected"": true," + "\n" +
@"      ""available"": true," + "\n" +
@"      ""number"": ""+972544440099""" + "\n" +
@"    }" + "\n" +
@"  ]" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "{{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings/{{phoneDeliverySettingsID}}"
  method := "PUT"

  payload := strings.NewReader(`{
  "id": "updatedTwilioPhoneDeliverySettingsId",
  "sid": "updatedSid",
  "provider": "CUSTOM_TWILIO",
  "numbers": [
    {
      "type": "SHORT_CODE",
      "capabilities": [
        "SMS"
      ],
      "selected": true,
      "available": true,
      "number": "894546"
    },
    {
      "type": "SHORT_CODE",
      "capabilities": [
        "SMS"
      ],
      "selected": false,
      "available": true,
      "number": "894545",
      "supportedCountries": ["CA"]
    },
    {
      "type": "TOLL_FREE",
      "capabilities": [
        "SMS",
        "VOICE"
      ],
      "selected": true,
      "available": true,
      "number": "+18544440099",
      "supportedCountries": ["US", "CA"]
    },
    {
      "type": "TOLL_FREE",
      "capabilities": [
        "SMS",
        "VOICE"
      ],
      "selected": false,
      "available": true,
      "number": "+18544440098",
      "supportedCountries": ["ALL"]
    },
    {
      "type": "PHONE_NUMBER",
      "capabilities": [
        "SMS",
        "VOICE"
      ],
      "selected": true,
      "available": true,
      "number": "+172544440091"
    },
    {
      "type": "PHONE_NUMBER",
      "capabilities": [
        "SMS",
        "VOICE"
      ],
      "selected": true,
      "available": true,
      "number": "+972544440099"
    }
  ]
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Authorization", "Bearer {{accessToken}}")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

PUT /environments/{{envID}}/notificationsSettings/phoneDeliverySettings/{{phoneDeliverySettingsID}} HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

{
  "id": "updatedTwilioPhoneDeliverySettingsId",
  "sid": "updatedSid",
  "provider": "CUSTOM_TWILIO",
  "numbers": [
    {
      "type": "SHORT_CODE",
      "capabilities": [
        "SMS"
      ],
      "selected": true,
      "available": true,
      "number": "894546"
    },
    {
      "type": "SHORT_CODE",
      "capabilities": [
        "SMS"
      ],
      "selected": false,
      "available": true,
      "number": "894545",
      "supportedCountries": ["CA"]
    },
    {
      "type": "TOLL_FREE",
      "capabilities": [
        "SMS",
        "VOICE"
      ],
      "selected": true,
      "available": true,
      "number": "+18544440099",
      "supportedCountries": ["US", "CA"]
    },
    {
      "type": "TOLL_FREE",
      "capabilities": [
        "SMS",
        "VOICE"
      ],
      "selected": false,
      "available": true,
      "number": "+18544440098",
      "supportedCountries": ["ALL"]
    },
    {
      "type": "PHONE_NUMBER",
      "capabilities": [
        "SMS",
        "VOICE"
      ],
      "selected": true,
      "available": true,
      "number": "+172544440091"
    },
    {
      "type": "PHONE_NUMBER",
      "capabilities": [
        "SMS",
        "VOICE"
      ],
      "selected": true,
      "available": true,
      "number": "+972544440099"
    }
  ]
}

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"id\": \"updatedTwilioPhoneDeliverySettingsId\",\n  \"sid\": \"updatedSid\",\n  \"provider\": \"CUSTOM_TWILIO\",\n  \"numbers\": [\n    {\n      \"type\": \"SHORT_CODE\",\n      \"capabilities\": [\n        \"SMS\"\n      ],\n      \"selected\": true,\n      \"available\": true,\n      \"number\": \"894546\"\n    },\n    {\n      \"type\": \"SHORT_CODE\",\n      \"capabilities\": [\n        \"SMS\"\n      ],\n      \"selected\": false,\n      \"available\": true,\n      \"number\": \"894545\",\n      \"supportedCountries\": [\"CA\"]\n    },\n    {\n      \"type\": \"TOLL_FREE\",\n      \"capabilities\": [\n        \"SMS\",\n        \"VOICE\"\n      ],\n      \"selected\": true,\n      \"available\": true,\n      \"number\": \"+18544440099\",\n      \"supportedCountries\": [\"US\", \"CA\"]\n    },\n    {\n      \"type\": \"TOLL_FREE\",\n      \"capabilities\": [\n        \"SMS\",\n        \"VOICE\"\n      ],\n      \"selected\": false,\n      \"available\": true,\n      \"number\": \"+18544440098\",\n      \"supportedCountries\": [\"ALL\"]\n    },\n    {\n      \"type\": \"PHONE_NUMBER\",\n      \"capabilities\": [\n        \"SMS\",\n        \"VOICE\"\n      ],\n      \"selected\": true,\n      \"available\": true,\n      \"number\": \"+172544440091\"\n    },\n    {\n      \"type\": \"PHONE_NUMBER\",\n      \"capabilities\": [\n        \"SMS\",\n        \"VOICE\"\n      ],\n      \"selected\": true,\n      \"available\": true,\n      \"number\": \"+972544440099\"\n    }\n  ]\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings/{{phoneDeliverySettingsID}}")
  .method("PUT", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();

var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings/{{phoneDeliverySettingsID}}",
  "method": "PUT",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "id": "updatedTwilioPhoneDeliverySettingsId",
    "sid": "updatedSid",
    "provider": "CUSTOM_TWILIO",
    "numbers": [
      {
        "type": "SHORT_CODE",
        "capabilities": [
          "SMS"
        ],
        "selected": true,
        "available": true,
        "number": "894546"
      },
      {
        "type": "SHORT_CODE",
        "capabilities": [
          "SMS"
        ],
        "selected": false,
        "available": true,
        "number": "894545",
        "supportedCountries": [
          "CA"
        ]
      },
      {
        "type": "TOLL_FREE",
        "capabilities": [
          "SMS",
          "VOICE"
        ],
        "selected": true,
        "available": true,
        "number": "+18544440099",
        "supportedCountries": [
          "US",
          "CA"
        ]
      },
      {
        "type": "TOLL_FREE",
        "capabilities": [
          "SMS",
          "VOICE"
        ],
        "selected": false,
        "available": true,
        "number": "+18544440098",
        "supportedCountries": [
          "ALL"
        ]
      },
      {
        "type": "PHONE_NUMBER",
        "capabilities": [
          "SMS",
          "VOICE"
        ],
        "selected": true,
        "available": true,
        "number": "+172544440091"
      },
      {
        "type": "PHONE_NUMBER",
        "capabilities": [
          "SMS",
          "VOICE"
        ],
        "selected": true,
        "available": true,
        "number": "+972544440099"
      }
    ]
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

var request = require('request');
var options = {
  'method': 'PUT',
  'url': '{{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings/{{phoneDeliverySettingsID}}',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "id": "updatedTwilioPhoneDeliverySettingsId",
    "sid": "updatedSid",
    "provider": "CUSTOM_TWILIO",
    "numbers": [
      {
        "type": "SHORT_CODE",
        "capabilities": [
          "SMS"
        ],
        "selected": true,
        "available": true,
        "number": "894546"
      },
      {
        "type": "SHORT_CODE",
        "capabilities": [
          "SMS"
        ],
        "selected": false,
        "available": true,
        "number": "894545",
        "supportedCountries": [
          "CA"
        ]
      },
      {
        "type": "TOLL_FREE",
        "capabilities": [
          "SMS",
          "VOICE"
        ],
        "selected": true,
        "available": true,
        "number": "+18544440099",
        "supportedCountries": [
          "US",
          "CA"
        ]
      },
      {
        "type": "TOLL_FREE",
        "capabilities": [
          "SMS",
          "VOICE"
        ],
        "selected": false,
        "available": true,
        "number": "+18544440098",
        "supportedCountries": [
          "ALL"
        ]
      },
      {
        "type": "PHONE_NUMBER",
        "capabilities": [
          "SMS",
          "VOICE"
        ],
        "selected": true,
        "available": true,
        "number": "+172544440091"
      },
      {
        "type": "PHONE_NUMBER",
        "capabilities": [
          "SMS",
          "VOICE"
        ],
        "selected": true,
        "available": true,
        "number": "+972544440099"
      }
    ]
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

import requests
import json

url = "{{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings/{{phoneDeliverySettingsID}}"

payload = json.dumps({
  "id": "updatedTwilioPhoneDeliverySettingsId",
  "sid": "updatedSid",
  "provider": "CUSTOM_TWILIO",
  "numbers": [
    {
      "type": "SHORT_CODE",
      "capabilities": [
        "SMS"
      ],
      "selected": True,
      "available": True,
      "number": "894546"
    },
    {
      "type": "SHORT_CODE",
      "capabilities": [
        "SMS"
      ],
      "selected": False,
      "available": True,
      "number": "894545",
      "supportedCountries": [
        "CA"
      ]
    },
    {
      "type": "TOLL_FREE",
      "capabilities": [
        "SMS",
        "VOICE"
      ],
      "selected": True,
      "available": True,
      "number": "+18544440099",
      "supportedCountries": [
        "US",
        "CA"
      ]
    },
    {
      "type": "TOLL_FREE",
      "capabilities": [
        "SMS",
        "VOICE"
      ],
      "selected": False,
      "available": True,
      "number": "+18544440098",
      "supportedCountries": [
        "ALL"
      ]
    },
    {
      "type": "PHONE_NUMBER",
      "capabilities": [
        "SMS",
        "VOICE"
      ],
      "selected": True,
      "available": True,
      "number": "+172544440091"
    },
    {
      "type": "PHONE_NUMBER",
      "capabilities": [
        "SMS",
        "VOICE"
      ],
      "selected": True,
      "available": True,
      "number": "+972544440099"
    }
  ]
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{accessToken}}'
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.text)

<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings/{{phoneDeliverySettingsID}}');
$request->setMethod(HTTP_Request2::METHOD_PUT);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n  "id": "updatedTwilioPhoneDeliverySettingsId",\n  "sid": "updatedSid",\n  "provider": "CUSTOM_TWILIO",\n  "numbers": [\n    {\n      "type": "SHORT_CODE",\n      "capabilities": [\n        "SMS"\n      ],\n      "selected": true,\n      "available": true,\n      "number": "894546"\n    },\n    {\n      "type": "SHORT_CODE",\n      "capabilities": [\n        "SMS"\n      ],\n      "selected": false,\n      "available": true,\n      "number": "894545",\n      "supportedCountries": ["CA"]\n    },\n    {\n      "type": "TOLL_FREE",\n      "capabilities": [\n        "SMS",\n        "VOICE"\n      ],\n      "selected": true,\n      "available": true,\n      "number": "+18544440099",\n      "supportedCountries": ["US", "CA"]\n    },\n    {\n      "type": "TOLL_FREE",\n      "capabilities": [\n        "SMS",\n        "VOICE"\n      ],\n      "selected": false,\n      "available": true,\n      "number": "+18544440098",\n      "supportedCountries": ["ALL"]\n    },\n    {\n      "type": "PHONE_NUMBER",\n      "capabilities": [\n        "SMS",\n        "VOICE"\n      ],\n      "selected": true,\n      "available": true,\n      "number": "+172544440091"\n    },\n    {\n      "type": "PHONE_NUMBER",\n      "capabilities": [\n        "SMS",\n        "VOICE"\n      ],\n      "selected": true,\n      "available": true,\n      "number": "+972544440099"\n    }\n  ]\n}');
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}

require "uri"
require "json"
require "net/http"

url = URI("{{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings/{{phoneDeliverySettingsID}}")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Put.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
  "id": "updatedTwilioPhoneDeliverySettingsId",
  "sid": "updatedSid",
  "provider": "CUSTOM_TWILIO",
  "numbers": [
    {
      "type": "SHORT_CODE",
      "capabilities": [
        "SMS"
      ],
      "selected": true,
      "available": true,
      "number": "894546"
    },
    {
      "type": "SHORT_CODE",
      "capabilities": [
        "SMS"
      ],
      "selected": false,
      "available": true,
      "number": "894545",
      "supportedCountries": [
        "CA"
      ]
    },
    {
      "type": "TOLL_FREE",
      "capabilities": [
        "SMS",
        "VOICE"
      ],
      "selected": true,
      "available": true,
      "number": "+18544440099",
      "supportedCountries": [
        "US",
        "CA"
      ]
    },
    {
      "type": "TOLL_FREE",
      "capabilities": [
        "SMS",
        "VOICE"
      ],
      "selected": false,
      "available": true,
      "number": "+18544440098",
      "supportedCountries": [
        "ALL"
      ]
    },
    {
      "type": "PHONE_NUMBER",
      "capabilities": [
        "SMS",
        "VOICE"
      ],
      "selected": true,
      "available": true,
      "number": "+172544440091"
    },
    {
      "type": "PHONE_NUMBER",
      "capabilities": [
        "SMS",
        "VOICE"
      ],
      "selected": true,
      "available": true,
      "number": "+972544440099"
    }
  ]
})

response = http.request(request)
puts response.read_body

let parameters = "{\n  \"id\": \"updatedTwilioPhoneDeliverySettingsId\",\n  \"sid\": \"updatedSid\",\n  \"provider\": \"CUSTOM_TWILIO\",\n  \"numbers\": [\n    {\n      \"type\": \"SHORT_CODE\",\n      \"capabilities\": [\n        \"SMS\"\n      ],\n      \"selected\": true,\n      \"available\": true,\n      \"number\": \"894546\"\n    },\n    {\n      \"type\": \"SHORT_CODE\",\n      \"capabilities\": [\n        \"SMS\"\n      ],\n      \"selected\": false,\n      \"available\": true,\n      \"number\": \"894545\",\n      \"supportedCountries\": [\"CA\"]\n    },\n    {\n      \"type\": \"TOLL_FREE\",\n      \"capabilities\": [\n        \"SMS\",\n        \"VOICE\"\n      ],\n      \"selected\": true,\n      \"available\": true,\n      \"number\": \"+18544440099\",\n      \"supportedCountries\": [\"US\", \"CA\"]\n    },\n    {\n      \"type\": \"TOLL_FREE\",\n      \"capabilities\": [\n        \"SMS\",\n        \"VOICE\"\n      ],\n      \"selected\": false,\n      \"available\": true,\n      \"number\": \"+18544440098\",\n      \"supportedCountries\": [\"ALL\"]\n    },\n    {\n      \"type\": \"PHONE_NUMBER\",\n      \"capabilities\": [\n        \"SMS\",\n        \"VOICE\"\n      ],\n      \"selected\": true,\n      \"available\": true,\n      \"number\": \"+172544440091\"\n    },\n    {\n      \"type\": \"PHONE_NUMBER\",\n      \"capabilities\": [\n        \"SMS\",\n        \"VOICE\"\n      ],\n      \"selected\": true,\n      \"available\": true,\n      \"number\": \"+972544440099\"\n    }\n  ]\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings/{{phoneDeliverySettingsID}}")!,timeoutInterval: Double.infinity)
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")

request.httpMethod = "PUT"
request.httpBody = postData

let task = URLSession.shared.dataTask(with: request) { data, response, error in
  guard let data = data else {
    print(String(describing: error))
    return
  }
  print(String(data: data, encoding: .utf8)!)
}

task.resume()

Example Response

200 OK

{
    "_links": {
        "self": {
            "href": "http://api.pingone.com/environments/someEnvId/notificationsSettings/phoneDeliverySettings/2c39f0c2-5e58-42c6-8561-926b1c1e6028"
        },
        "environment": {
            "href": "http://api.pingone.com/environments/someEnvId/notificationsSettings"
        }
    },
    "id": "2c39f0c2-5e58-42c6-8561-926b1c1e6028",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "createdAt": "2020-05-19T10:25:23.319Z",
    "updatedAt": "2020-05-19T10:25:23.319Z",
    "sid": "d253292c-8740-4338-b886-17678bcbe6cc",
    "numbers": [
        {
            "type": "PHONE_NUMBER",
            "selected": false,
            "available": true,
            "createdAt": "2020-05-19T10:25:23.828Z",
            "number": "+12024706245",
            "capabilities": [
                "SMS",
                "VOICE"
            ]
        },
        {
            "type": "PHONE_NUMBER",
            "selected": false,
            "available": true,
            "createdAt": "2020-05-19T10:25:23.828Z",
            "number": "+13462445724",
            "capabilities": [
                "SMS",
                "VOICE"
            ]
        },
        {
            "type": "TOLL_FREE",
            "selected": false,
            "available": true,
            "createdAt": "2020-05-19T10:25:23.828Z",
            "number": "+18449840672",
            "capabilities": [
                "SMS",
                "VOICE"
            ],
            "supportedCountries": [
                "US",
                "CA"
            ]
        },
        {
            "type": "PHONE_NUMBER",
            "selected": false,
            "available": true,
            "createdAt": "2020-05-19T10:25:23.828Z",
            "number": "+13025817557",
            "capabilities": [
                "SMS",
                "VOICE"
            ]
        },
        {
            "type": "PHONE_NUMBER",
            "selected": false,
            "available": true,
            "createdAt": "2020-05-19T10:25:23.828Z",
            "number": "+972521209508",
            "capabilities": [
                "SMS",
                "VOICE"
            ]
        },
        {
            "type": "PHONE_NUMBER",
            "selected": false,
            "available": true,
            "createdAt": "2020-05-19T10:25:23.828Z",
            "number": "+61488846054",
            "capabilities": [
                "SMS",
                "VOICE"
            ]
        },
        {
            "type": "PHONE_NUMBER",
            "selected": false,
            "available": true,
            "createdAt": "2020-05-19T10:25:23.828Z",
            "number": "+19182157058",
            "capabilities": [
                "SMS",
                "VOICE"
            ]
        }
    ],
    "provider": "BYO_TWILIO"
}

PingOne Platform APIs

Update Phone Delivery Settings (Twilio)

Prerequisites

Headers

Body

Example Request

Example Response