Skip to main content
POST
/
messaging_numbers
/
bulk_updates
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const messagingNumbersBulkUpdate = await client.messagingNumbersBulkUpdates.create({
  messaging_profile_id: '00000000-0000-0000-0000-000000000000',
  numbers: ['+18880000000', '+18880000001', '+18880000002'],
});

console.log(messagingNumbersBulkUpdate.data);
import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
messaging_numbers_bulk_update = client.messaging_numbers_bulk_updates.create(
    messaging_profile_id="00000000-0000-0000-0000-000000000000",
    numbers=["+18880000000", "+18880000001", "+18880000002"],
)
print(messaging_numbers_bulk_update.data)
package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	messagingNumbersBulkUpdate, err := client.MessagingNumbersBulkUpdates.New(context.TODO(), telnyx.MessagingNumbersBulkUpdateNewParams{
		MessagingProfileID: "00000000-0000-0000-0000-000000000000",
		Numbers:            []string{"+18880000000", "+18880000001", "+18880000002"},
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", messagingNumbersBulkUpdate.Data)
}
package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.messagingnumbersbulkupdates.MessagingNumbersBulkUpdateCreateParams;
import com.telnyx.sdk.models.messagingnumbersbulkupdates.MessagingNumbersBulkUpdateCreateResponse;
import java.util.List;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        MessagingNumbersBulkUpdateCreateParams params = MessagingNumbersBulkUpdateCreateParams.builder()
            .messagingProfileId("00000000-0000-0000-0000-000000000000")
            .numbers(List.of(
              "+18880000000",
              "+18880000001",
              "+18880000002"
            ))
            .build();
        MessagingNumbersBulkUpdateCreateResponse messagingNumbersBulkUpdate = client.messagingNumbersBulkUpdates().create(params);
    }
}
require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

messaging_numbers_bulk_update = telnyx.messaging_numbers_bulk_updates.create(
  messaging_profile_id: "00000000-0000-0000-0000-000000000000",
  numbers: ["+18880000000", "+18880000001", "+18880000002"]
)

puts(messaging_numbers_bulk_update)
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $messagingNumbersBulkUpdate = $client->messagingNumbersBulkUpdates->create(
    messagingProfileID: '00000000-0000-0000-0000-000000000000',
    numbers: ['+18880000000', '+18880000001', '+18880000002'],
    assignOnly: true,
  );

  var_dump($messagingNumbersBulkUpdate);
} catch (APIException $e) {
  echo $e->getMessage();
}
telnyx messaging-numbers-bulk-updates create \
  --api-key 'My API Key' \
  --messaging-profile-id 00000000-0000-0000-0000-000000000000 \
  --number "'+18880000000'" \
  --number "'+18880000001'" \
  --number "'+18880000002'"
curl --request POST \
  --url https://api.telnyx.com/v2/messaging_numbers/bulk_updates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "messaging_profile_id": "00000000-0000-0000-0000-000000000000",
  "numbers": [
    "+18880000000",
    "+18880000001",
    "+18880000002"
  ]
}
'
{
  "data": {
    "record_type": "messaging_numbers_bulk_update",
    "order_id": "00000000-0000-0000-0000-000000000000",
    "success": [
      "+18880000000",
      "+18880000001",
      "+18880000002"
    ],
    "pending": [],
    "failed": []
  }
}
{
  "errors": [
    {
      "code": "<string>",
      "title": "<string>",
      "detail": "<string>",
      "source": {
        "pointer": "<string>",
        "parameter": "<string>"
      },
      "meta": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
messaging_profile_id
string
required

Configure the messaging profile these phone numbers are assigned to:

  • Set this field to "" to unassign each number from their respective messaging profile
  • Set this field to a quoted UUID of a messaging profile to assign these numbers to that messaging profile
​
numbers
string[]
required

The list of phone numbers to update.

​
assign_only
boolean
default:false

If true, only assign numbers to the profile without changing other settings.

Response

Successful response with details about messaging bulk update phone numbers.

​
data
object
Example:
{
  "record_type": "messaging_numbers_bulk_update",
  "order_id": "00000000-0000-0000-0000-000000000000",
  "success": [
    "+18880000000",
    "+18880000001",
    "+18880000002"
  ],
  "pending": [],
  "failed": []
}