Update Config

Updates advanced configuration settings for a specified user account, including notification preferences, cell phone contact information, and other user-level options.

Endpoint

POST /v2/users/update-config

Request Body

Field	Type	Required	Constraints	Description
userId	integer	Yes	Must be an existing user	ID of the user whose configuration to update

Additional configuration fields are passed alongside userId. Omit any field to leave its current value unchanged.

{
  "userId": 1042
}

Response

Returns a boolean indicating whether the configuration was successfully updated.

{
  "success": true,
  "data": true
}

Code Examples

cURL

curl -X POST "https://rest.ecgrid.io/v2/users/update-config" \
  -H "X-API-Key: $ECGRID_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "userId": 1042 }'

C#

// .NET 10 — Update advanced user configuration settings using IHttpClientFactory
public async Task<bool> UpdateUserConfigAsync(
    IHttpClientFactory httpClientFactory,
    int userId,
    object? additionalConfig = null)
{
    var http = httpClientFactory.CreateClient("ECGridRest");

    // Merge userId with any additional config fields provided by the caller
    var requestBody = new System.Text.Json.Nodes.JsonObject
    {
        ["userId"] = userId
    };

    if (additionalConfig is not null)
    {
        var extraJson = System.Text.Json.JsonSerializer.SerializeToNode(additionalConfig);
        if (extraJson is System.Text.Json.Nodes.JsonObject extraObj)
        {
            foreach (var prop in extraObj)
            {
                requestBody[prop.Key] = prop.Value?.DeepClone();
            }
        }
    }

    var response = await http.PostAsJsonAsync(
        "https://rest.ecgrid.io/v2/users/update-config",
        requestBody);
    response.EnsureSuccessStatusCode();

    var result = await response.Content.ReadFromJsonAsync<ApiResponse<bool>>();
    return result?.Data ?? false;
}

Java

import java.net.URI;
import java.net.http.*;

String apiKey = System.getenv("ECGRID_API_KEY");

String body = "{ \"userId\": 1042 }";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://rest.ecgrid.io/v2/users/update-config"))
    .header("X-API-Key", apiKey)
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .build();

HttpClient client = HttpClient.newHttpClient();
HttpResponse<String> response = client.send(
    request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

Node.js

const apiKey = process.env.ECGRID_API_KEY;
const url = 'https://rest.ecgrid.io/v2/users/update-config';

const response = await fetch(url, {
  method: 'POST',
  headers: {
    'X-API-Key': apiKey,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ "userId": 1042 }),
});

const data = await response.json();
console.log(data);

Python

import os, requests

api_key = os.environ["ECGRID_API_KEY"]
headers = {"X-API-Key": api_key}
url = "https://rest.ecgrid.io/v2/users/update-config"

response = requests.post(
    url,
    json={ "userId": 1042 },
    headers=headers,
)

response.raise_for_status()
print(response.json())

See Also

• Update User — update core profile fields (name, email)
• Set Role — change the user's AuthLevel
• Set Network Mailbox — change the user's network or mailbox context
• Send SMS — send a message using the cell carrier configured here