Update group
Base URL:
PATCH: https://api.smsgatewayapi.com/v1/groups/
Parameter | Input | Description | |
---|---|---|---|
client_id | API client ID | Can be found in your API documentation | Required |
client_secret | API client secret | Can be found in your API documentation | Required |
ID | Group ID | Group ID to be modified | Required |
name | Name of the group | The new name of the group | Required |
<?php $ch = curl_init(); $url = "https://api.smsgatewayapi.com/v1/groups/"; $client_id = "XXX"; // Your API client ID (required) $client_secret = "YYY"; // Your API client secret (required) $data = [ 'ID' => {ID}, //Group ID (required) 'name' => "Marketing" //Name of the group (required) ];
curl_setopt($ch, CURLOPT_URL, "$url"); curl_setopt($ch, CURLOPT_POST, true); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH'); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_VERBOSE, true); curl_setopt($ch, CURLOPT_HTTPHEADER, [ "X-Client-Id: $client_id", "X-Client-Secret: $client_secret", "Content-Type: application/json", ]); curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data)); $response = curl_exec($ch); ?>
Example request single:
{ "ID": {ID}, "name": "marketing" }
Example request multiple:
[ { "ID": {ID} "name": "marketing" }, { "ID": {ID}, "name": "production" } ]
If one or more IDs are not found, the API returns a 404 status code and all modifications of the current request are canceled.
Example response single:
{ "ID": [ {id} ] }
Example response multiple:
{ "IDs": [ {id1}, {id2}, ...] }