# Assign a Batch of Subusers to an IP

## API Overview

The IP Address Management API combines functionality that was previously split between the Twilio SendGrid [IP Address API](/docs/sendgrid/api-reference/ip-address) and [IP Pools API](/docs/sendgrid/api-reference/ip-pools). This functionality includes adding IP addresses to your account, assigning IP addresses to IP Pools and Subusers, among other tasks. More details about each operation can be found in the descriptions and schemas for each endpoint.

> \[!NOTE]
>
> Regional Email sending in the European Union (EU) is available for [Twilio SendGrid Pro plan or above](https://sendgrid.com/en-us/pricing). EU Regional Email sending requires use of an EU IP address and EU subuser. Learn more about [sending emails with Twilio SendGrid on EU servers](https://www.twilio.com/en-us/blog/send-emails-in-eu).

> \[!WARNING]
>
> The IP Address Management API is in public beta at this time. This means the API and documentation are still in development and subject to change without advanced notice.

## Operation overview

```json
{"path":"https://api.sendgrid.com/v3/send_ips/ips/{ip}/subusers:batchAdd","method":"post","servers":[{"url":"https://api.sendgrid.com","description":"for global users"}]}
```

This operation appends a batch of Subusers to a specified IP address. This endpoint requires all Subuser assignments to succeed. If a Subuser assignment fails, this endpoint will return an error.

## Operation details

### Authentication

API Key

### Headers

```json
[{"in":"header","name":"Authorization","required":true,"default":"Bearer <<YOUR_API_KEY_HERE>>","schema":{"type":"string"}}]
```

### Path parameters

```json
[{"name":"ip","in":"path","schema":{"type":"string"},"description":"The `ip` path parameter specifies an IP address to make the request against.","required":true,"refName":"#/components/parameters/IpAddressManagementPathIp","modelName":"__components_parameters_IpAddressManagementPathIp"}]
```

### Request body

```json
{"schema":{"type":"object","required":["subusers"],"properties":{"subusers":{"type":"array","description":"An array of Subuser IDs to be assigned to the specified IP address. All Subuser assignments must succeed.","items":{"type":"string"}}}},"examples":{"example-1":{"value":{"subusers":["12345","67890"]}}},"encodingType":"application/json"}
```

### Responses

```json
[{"responseCode":"200","schema":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"ip":{"type":"string","description":"The IP address the Subusers were assigned to."},"subusers":{"type":"array","description":"An array of Subuser IDs that were assigned to the specified IP address.","items":{"type":"string"}}}},"examples":{"example-1":{"value":{"ip":"127.0.0.1","subusers":["12345","67890"]}}}}}}},{"responseCode":"400","schema":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","example-1":{"errors":[{"field":"after_key","message":"must be a numeric value"}]},"description":"IP Address Management Error Response Schema","refName":"IpAddressManagementErrorResponse","modelName":"IpAddressManagementErrorResponse","properties":{"errors":{"type":"array","description":"An array of error objects.","items":{"type":"object","properties":{"field":{"type":"string","description":"Indicates which field caused the error. This may be an empty string if no specific field is responsible for the error."},"message":{"type":"string","description":"An error-specific message that provides more information about the error's cause."}}}}}},"examples":{"invalid ip address":{"value":{"errors":[{"field":"","message":"invalid IP address"}]},"refName":"#/components/examples/IpAddressManagement400InvalidIpError","modelName":"__components_examples_IpAddressManagement400InvalidIpError"},"JSON parse error":{"value":{"errors":[{"field":"","message":"failed to parse the request body as a JSON payload"}]},"refName":"#/components/examples/IpAddressManagement400JsonParseError","modelName":"__components_examples_IpAddressManagement400JsonParseError"},"subusers empty":{"value":{"errors":[{"field":"subusers","message":"must not be empty"}]},"refName":"#/components/examples/IpAddressManagement400SubusersEmptyError","modelName":"__components_examples_IpAddressManagement400SubusersEmptyError"},"subuser caller id error":{"value":{"errors":[{"field":"subusers","message":"cannot contain caller’s userID"}]},"refName":"#/components/examples/IpAddressManagement400SubusersCallerIdError","modelName":"__components_examples_IpAddressManagement400SubusersCallerIdError"},"subusers unverified":{"value":{"errors":[{"field":"subusers","message":"unverified subusers: 123, 456, 789"}]},"refName":"#/components/examples/IpAddressManagement400SubusersUnverifiedError","modelName":"__components_examples_IpAddressManagement400SubusersUnverifiedError"},"subusers limit exceeded":{"value":{"errors":[{"field":"subusers","message":"cannot assign more than 1000 subusers per call"}]},"refName":"#/components/examples/IpAddressManagement400SubusersLimitError","modelName":"__components_examples_IpAddressManagement400SubusersLimitError"}}}}}},{"responseCode":"401","schema":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","example-1":{"errors":[{"field":"after_key","message":"must be a numeric value"}]},"description":"IP Address Management Error Response Schema","x-examples":{"example-1":{"errors":[{"field":"","message":"missing required scope: scope1, scope2"}]}},"refName":"IpAddressManagementErrorResponse","modelName":"IpAddressManagementErrorResponse","properties":{"errors":{"type":"array","description":"An array of error objects.","items":{"type":"object","properties":{"field":{"type":"string","description":"Indicates which field caused the error. This may be an empty string if no specific field is responsible for the error."},"message":{"type":"string","description":"An error-specific message that provides more information about the error's cause."}}}}}},"examples":{"Missing required scope":{"value":{"errors":[{"field":"","message":"missing required scope: scope1, scope2"}]}}}},"application/xml":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}}}}},"x-examples":{"example-1":{"errors":[{"field":"","message":"missing required scope: scope1, scope2"}]}}}}},"refName":"#/components/responses/IpAddressManagement401","modelName":"__components_responses_IpAddressManagement401"}},{"responseCode":"500","schema":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","example-1":{"errors":[{"field":"after_key","message":"must be a numeric value"}]},"description":"IP Address Management Error Response Schema","x-examples":{"example-1":{"errors":[{"field":"","message":"internal server error"}]}},"refName":"IpAddressManagementErrorResponse","modelName":"IpAddressManagementErrorResponse","properties":{"errors":{"type":"array","description":"An array of error objects.","items":{"type":"object","properties":{"field":{"type":"string","description":"Indicates which field caused the error. This may be an empty string if no specific field is responsible for the error."},"message":{"type":"string","description":"An error-specific message that provides more information about the error's cause."}}}}}},"examples":{"Generic 500":{"value":{"errors":[{"field":"","message":"internal server error"}]}}}}},"refName":"#/components/responses/IpAddressManagement500","modelName":"__components_responses_IpAddressManagement500"}}]
```

Assign a Batch of Subusers to an IP

```js
const client = require("@sendgrid/client");
client.setApiKey(process.env.SENDGRID_API_KEY);

const ip = "ip";
const data = {
  subusers: ["12345", "67890"],
};

const request = {
  url: `/v3/send_ips/ips/${ip}/subusers:batchAdd`,
  method: "POST",
  body: data,
};

client
  .request(request)
  .then(([response, body]) => {
    console.log(response.statusCode);
    console.log(response.body);
  })
  .catch((error) => {
    console.error(error);
  });
```

```python
import os
from sendgrid import SendGridAPIClient


sg = SendGridAPIClient(os.environ.get("SENDGRID_API_KEY"))

ip = "ip"
data = {"subusers": ["12345", "67890"]}

response = sg.client._(f"send_ips/ips/{ip}/subusers:batchAdd").post(
    request_body=data
)

print(response.status_code)
print(response.body)
print(response.headers)
```

```csharp
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using SendGrid;

public class Program {
    public static async Task Main() {
        string apiKey = Environment.GetEnvironmentVariable("SENDGRID_API_KEY");
        var client = new SendGridClient(apiKey);

        var ip = "ip";
        var data =
            @"{
            ""subusers"": [
                ""12345"",
                ""67890""
            ]
        }";

        var response = await client.RequestAsync(
            method: SendGridClient.Method.POST,
            urlPath: $"send_ips/ips/{ip}/subusers:batchAdd",
            requestBody: data);

        Console.WriteLine(response.StatusCode);
        Console.WriteLine(response.Body.ReadAsStringAsync().Result);
        Console.WriteLine(response.Headers.ToString());
    }
}
```

```java
import com.sendgrid.*;
import java.io.IOException;
import org.json.JSONObject;
import java.util.HashMap;
import java.util.Arrays;

public class Example {
    public static void main(String[] args) throws IOException {
        try {
            SendGrid sg = new SendGrid(System.getenv("SENDGRID_API_KEY"));
            Request request = new Request();
            request.setMethod(Method.POST);
            request.setEndpoint("/send_ips/ips/ip/subusers:batchAdd");
            request.setBody(new JSONObject(new HashMap<String, Object>() {
                {
                    put("subusers", Arrays.asList("12345", "67890"));
                }
            }).toString());
            Response response = sg.api(request);
            System.out.println(response.getStatusCode());
            System.out.println(response.getBody());
            System.out.println(response.getHeaders());
        } catch (IOException ex) {
            throw ex;
        }
    }
}
```

```go
package main

import (
	"fmt"
	"github.com/sendgrid/sendgrid-go"
	"os"
)

func main() {
	apiKey := os.Getenv("SENDGRID_API_KEY")
	host := "https://api.sendgrid.com"
	request := sendgrid.GetRequest(apiKey, "/v3/send_ips/ips/ip/subusers:batchAdd", host)
	request.Method = "POST"
	request.Body = []byte(`{
  "subusers": [
    "12345",
    "67890"
  ]
}`)
	response, err := sendgrid.API(request)
	if err != nil {
		fmt.Println(err.Error())
		os.Exit(1)
	} else {
		fmt.Println(response.StatusCode)
		fmt.Println(response.Body)
		fmt.Println(response.Headers)
	}
}
```

```php
<?php
// Uncomment the next line if you're using a dependency loader (such as Composer) (recommended)
// require 'vendor/autoload.php';

// Uncomment next line if you're not using a dependency loader (such as Composer)
// require_once '<PATH TO>/sendgrid-php.php';

$apiKey = getenv("SENDGRID_API_KEY");
$sg = new \SendGrid($apiKey);
$request_body = json_decode('{
    "subusers": [
        "12345",
        "67890"
    ]
}');
$ip = "ip";

try {
    $response = $sg->client
        ->_("send_ips/ips/{$ip}/subusers:batchAdd")
        ->post($request_body);
    print $response->statusCode() . "\n";
    print_r($response->headers());
    print $response->body() . "\n";
} catch (Exception $ex) {
    echo "Caught exception: " . $ex->getMessage();
}
```

```ruby
require 'sendgrid-ruby'
include SendGrid

sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
data = JSON.parse('{
  "subusers": [
    "12345",
    "67890"
  ]
}')
ip = "ip"

response = sg.client._("send_ips/ips/#{ip}/subusers:batchAdd").post(request_body: data)
puts response.status_code
puts response.headers
puts response.body
```

```bash
curl -X POST "https://api.sendgrid.com/v3/send_ips/ips/ip/subusers:batchAdd" \
--header "Authorization: Bearer $SENDGRID_API_KEY" \
--header "Content-Type: application/json" \
--data '{"subusers": ["12345", "67890"]}'
```