Update birthday message
Base URL:
PATCH: https://api.smsgatewayapi.com/v1/birthday-message/
| Parameter | Input | Description | |
|---|---|---|---|
| client_id | API client ID | Login and go to 'Advanced' - 'API authentication' to find the API keys | Required |
| client_secret | API client secret | Login and go to 'Advanced' - 'API authentication' to find the API keys | Required |
| ID | birthday id | The ID of the birthday message to be updated | Required |
| message | message | The text of the birthday message to be updated | Optional |
| sender | sender | The sender of the birthday message | Optional |
| groupid | groupid | The group id of the birthday message | Optional |
| hour | hour | The hour of the birthday message | Optional |
| offset_days | offset_days | The days offset of the birthday message | Optional |
| status | status | The status of the birthday message | Optional |
<?php
//PHP - cURL
$ch = curl_init();
$url = "https://api.smsgatewayapi.com/v1/birthday-message/";
$client_id = "XXX"; // Your API client ID (required)
$client_secret = "YYY"; // Your API client secret (required)
$data = [
'ID' => {ID} //Birthday ID (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},
"message": "Happy Birthday [FIRSTNAME]!"
"hour": 7,
"active": 1
}
Example request multiple:
[
{
"ID": {ID},
"message": "Happy Birthday [FIRSTNAME]!"
"status": 1
},
{
"ID": {ID},
"hour": 9,
"offset_days" : -3,
},
...
]
Example response single:
{
"ID": [ {id} ]
}
Example response multiple:
{
"IDs": [ {id1}, {id2}, ...]
}
