We use cookies to personalise content and ads, to provide social media features and to analyse our traffic. We also share information about your use of our site with our social media, advertising and analytics partners who may combine it with other information that you’ve provided to them or that they’ve collected from your use of their services.Learn more about who we are, how you can contact us and how we process personal data in our Privacy Policy.
Update contact
Base URL:
PATCH: https://api.smsgatewayapi.com/v1/contact
| 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 | contact ID | The ID of the contact to be modified | Required |
| phone | phone number | The phone number of the contact | Optional |
| groupid | group ID | Group ID the contact will be added to | Optional |
| firstname | first name | The first name of the contact | Optional |
| lastname | last name | The last name of the contact | Optional |
| birthday | birthday | Birthday of the contact. Format: yyyy-MM-dd | Optional |
| extra1 to extra8 | user defined fields | user defined fields, check your advanced settings | Optional |
| unsubscribed | unsubscribed | Optional |
<?php
//PHP - cURL
$ch = curl_init();
$url = "https://api.smsgatewayapi.com/v1/contact";
$client_id = "XXX"; // Your API client ID (required)
$client_secret = "YYY"; // Your API client secret (required)
$data = [
'ID' => {ID} //Contact 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}",
"extra2": "Building 2B"
}
Example request multiple:
[
{
"ID": "{ID1}",
"extra2": "Building 2B"
},
{
"ID": "{ID2}",
"extra3": "Monday"
}
]
Properties that are not given will not be modified.
If one or more IDs are not found, the API returns a 404 status code and all modifications of the current request are canceled.
The api will return a http 204 status code on success.