Devices API

Overview of mobile devices API methods
post
Register Device
https://api.codemash.io/:version/notifications/push/devices
Registers a device without a token. Devices without a token won't receive push notifications.
Request
Response
Request
Path Parameters
version
required
string
The version of the API endpoint. Current latest v1.
Headers
Authorization
required
string
Your project's secret key.
x-cm-projectid
required
string
Your project's ID. Can be passed as a query parameter.
Body Parameters
userId
optional
string
The ID of a user.
timeZone
optional
string
The timezone of a device in a tz database format.
meta
optional
object
Key-value pair (string: string) object for custom data.
Response
200: OK
Returns an ID of created notification group.
{
    Result: ""
}
401: Unauthorized
Returns if the user does not have a valid permission to call this method.
​
500: Internal Server Error
​
.NET
Node
PHP
.NET
var client = new CodeMashClient(apiKey, projectId);
var pushService = new CodeMashPushService(client);
​
var response = await pushService.RegisterDeviceAsync(
    new RegisterDeviceRequest
    {
        UserId = Guid.parse("{USER_ID}"),
        TimeZone = "Etc/UTC",
        Meta = new Dictionary<string, string>
        {
            { "Os", "Android" }            
        }
    }
Node
​
PHP
use Codemash\CodemashClient;
use Codemash\CodemashPushNotification;
​
class CodemashService
{
    protected CodemashPushNotification $codemashPushNotification;
​
    public function __construct()
    {
        $secretKey = '{YOUR_SECRET_KEY}';
        $projectId = '{YOUR_PROJECT_ID}';
​
        $client = new CodemashClient($secretKey, $projectId);
        $codemashPushNotification = new CodemashPushNotification($client);
    }
    
    public function registerDevice()
    {
        $responseData = $this->codemashPushNotification->registerDevice([
            'userId' => '{USER_ID}',
            'timeZone' => 'Etc/UTC',
            'meta' => [
                'Brand' => 'Apple'
            ]
    }
    
}
post
Register Expo Token
https://api.codemash.io/:version/notifications/push/token/expo
Registers a device with an Expo token and creates a device if not yet created. 
Request
Response
Request
Path Parameters
version
required
string
The version of the API endpoint. Current latest v1.
Headers
Authorization
required
string
Your project's secret key.
x-cm-projectid
required
string
Your project's ID. Can be passed as a query parameter.
Body Parameters
token
required
string
Token of a device provided by the Expo.
deviceId
optional
string
The ID of a device. If not provided, a new device will be added.
userId
optional
string
The ID of a user.
timeZone
optional
string
The timezone of a device in a tz database format.
meta
optional
object
Key-value pair (string: string) object for custom data.
Response
200: OK
Returns an ID of created notification group.
{
    Result: ""
}
401: Unauthorized
Returns if the user does not have a valid permission to call this method.
​
500: Internal Server Error
​
.NET
Node
PHP
.NET
var client = new CodeMashClient(apiKey, projectId);
var pushService = new CodeMashPushService(client);
​
var response = await pushService.RegisterExpoTokenAsync(
    new RegisterDeviceExpoTokenRequest
    {
        UserId = Guid.parse("{USER_ID}"),
        Token = "ExponentPushToken[**********************]",
        TimeZone = "Etc/UTC",
        Meta = new Dictionary<string, string>
        {
            { "Os", "Android" }            
        }
    }
Node
​
PHP
use Codemash\CodemashClient;
use Codemash\CodemashPushNotification;
​
class CodemashService
{
    protected CodemashPushNotification $codemashPushNotification;
​
    public function __construct()
    {
        $secretKey = '{YOUR_SECRET_KEY}';
        $projectId = '{YOUR_PROJECT_ID}';
​
        $client = new CodemashClient($secretKey, $projectId);
        $codemashPushNotification = new CodemashPushNotification($client);
    }
    
    public function registerExpoToken()
    {
        $responseData = $this->codemashPushNotification->registerExpoToken([
            'userId' => '{USER_ID}',
            'timeZone' => 'Etc/UTC',
            'meta' => [
                'Brand' => 'Apple'
            ],
            'token' => 'ExponentPushToken[**********************]',
        ]);
    }
    
}
get
Get Device
https://api.codemash.io/:version/notifications/push/devices/:id
Gets a device.
Request
Response
Request
Path Parameters
version
required
string
The version of the API endpoint. Current latest v1.
id
required
string
The ID of a device to get.
Headers
Authorization
required
string
Your project's secret key.
x-cm-projectid
required
string
Your project's ID. Can be passed as a query parameter.
Response
200: OK
Returns an ID of created notification group.
{
    Result: ""
}
401: Unauthorized
Returns if the user does not have a valid permission to call this method.
​
500: Internal Server Error
​
.NET
Node
PHP
.NET
var client = new CodeMashClient(apiKey, projectId);
var pushService = new CodeMashPushService(client);
​
var response = await pushService.GetDeviceAsync(
    new GetDeviceRequest
    {
        Id = "{DEVICE_ID}"
    }
);
Node
​
PHP
use Codemash\CodemashClient;
use Codemash\CodemashPushNotification;
​
class CodemashService
{
    protected CodemashPushNotification $codemashPushNotification;
​
    public function __construct()
    {
        $secretKey = '{YOUR_SECRET_KEY}';
        $projectId = '{YOUR_PROJECT_ID}';
​
        $client = new CodemashClient($secretKey, $projectId);
        $codemashPushNotification = new CodemashPushNotification($client);
    }
    
    public function getDevice()
    {
        $responseData = $this->codemashPushNotification->getDevice([
            'id' => '{DEVICE_ID}',
        ]);
    }
    
}
get
Get Devices
https://api.codemash.io/:version/notifications/push/devices
Gets many devices.
Request
Response
Request
Path Parameters
version
required
string
The version of the API endpoint. Current latest v1.
Headers
Authorization
required
string
Your project's secret key.
x-cm-projectid
required
string
Your project's ID. Can be passed as a query parameter.
Response
200: OK
Returns an ID of created notification group.
{
    Result: ""
}
401: Unauthorized
Returns if the user does not have a valid permission to call this method.
​
500: Internal Server Error
​
.NET
Node
PHP
.NET
var client = new CodeMashClient(apiKey, projectId);
var pushService = new CodeMashPushService(client);
​
var response = await pushService.GetDevicesAsync(
    new GetDevicesRequest()
);
Node
​
PHP
class CodemashService
{
    protected CodemashPushNotification $codemashPushNotification;
​
    public function __construct()
    {
        $secretKey = '{YOUR_SECRET_KEY}';
        $projectId = '{YOUR_PROJECT_ID}';
​
        $client = new CodemashClient($secretKey, $projectId);
        $codemashPushNotification = new CodemashPushNotification($client);
    }
    
    public function getDevices()
    {
        $responseData = $this->codemashPushNotification->getDevices();
    }
    
}
delete
Delete Device
https://api.codemash.io/:version/notifications/push/devices/:id
Deletes a particular device.
Request
Response
Request
Path Parameters
version
required
string
The version of the API endpoint. Current latest v1.
id
required
string
The ID of a device to delete.
Headers
Authorization
required
string
Your project's secret key.
x-cm-projectid
required
string
Your project's ID. Can be passed as a query parameter.
Response
200: OK
Returns an ID of created notification group.
{
    Result: ""
}
401: Unauthorized
Returns if the user does not have a valid permission to call this method.
​
500: Internal Server Error
​
.NET
Node
PHP
.NET
var client = new CodeMashClient(apiKey, projectId);
var pushService = new CodeMashPushService(client);
​
var response = await pushService.DeleteDeviceAsync(
    new DeleteDeviceRequest
    {
        Id = "{DEVICE_ID}"
    }
);
Node
​
PHP
class CodemashService
{
    protected CodemashPushNotification $codemashPushNotification;
​
    public function __construct()
    {
        $secretKey = '{YOUR_SECRET_KEY}';
        $projectId = '{YOUR_PROJECT_ID}';
​
        $client = new CodemashClient($secretKey, $projectId);
        $codemashPushNotification = new CodemashPushNotification($client);
    }
    
    public function deleteDevice()
    {
        $responseData = $this->codemashPushNotification->deleteDevice([
            'id' => '{DEVICE_ID}',
        ]);
    }
    
}
delete
Delete Device Token
https://api.codemash.io/:version/notifications/push/devices/:id/token
Deletes a token of a particular device.
Request
Response
Request
Path Parameters
version
required
string
The version of the API endpoint. Current latest v1.
id
required
string
The ID of a device.
Headers
Authorization
required
string
Your project's secret key.
x-cm-projectid
required
string
Your project's ID. Can be passed as a query parameter.
Response
200: OK
Returns an ID of created notification group.
{
    Result: ""
}
401: Unauthorized
Returns if the user does not have a valid permission to call this method.
​
500: Internal Server Error
​
.NET
Node
PHP
.NET
var client = new CodeMashClient(apiKey, projectId);
var pushService = new CodeMashPushService(client);
​
var response = await pushService.DeleteTokenAsync(
    new DeleteDeviceTokenRequest
    {
        Id = "{DEVICE_ID}"
    }
);
Node
​
PHP
class CodemashService
{
    protected CodemashPushNotification $codemashPushNotification;
​
    public function __construct()
    {
        $secretKey = '{YOUR_SECRET_KEY}';
        $projectId = '{YOUR_PROJECT_ID}';
​
        $client = new CodemashClient($secretKey, $projectId);
        $codemashPushNotification = new CodemashPushNotification($client);
    }
    
    public function deleteDeviceToken()
    {
        $responseData = $this->codemashPushNotification->deleteDeviceToken([
            'id' => '{DEVICE_ID}',
        ]);
    }
    
}
patch
Update Device Meta
https://api.codemash.io/:version/notifications/push/devices/:id/metadata
Updates a meta-information of a particular device.
Request
Response
Request
Path Parameters
version
required
string
The version of the API endpoint. Current latest v1.
id
required
string
The ID of a device to update.
Headers
Authorization
required
string
Your project's secret key.
x-cm-projectid
required
string
Your project's ID. Can be passed as a query parameter.
Body Parameters
meta
optional
string
Key-value pair (string: string) object of custom data.
Response
200: OK
Returns an ID of created notification group.
{
    Result: ""
}
401: Unauthorized
Returns if the user does not have a valid permission to call this method.
​
500: Internal Server Error
​
.NET
Node
PHP
.NET
var client = new CodeMashClient(apiKey, projectId);
var pushService = new CodeMashPushService(client);
​
var response = await pushService.UpdateDeviceMetaAsync(
    new UpdateDeviceMetaRequest
    {
        Id = "{DEVICE_ID}",
        Meta = new Dictionary<string, string>
        {
            { "Os", "iOs" }            
        }
    }
);
Node
​
PHP
class CodemashService
{
    protected CodemashPushNotification $codemashPushNotification;
​
    public function __construct()
    {
        $secretKey = '{YOUR_SECRET_KEY}';
        $projectId = '{YOUR_PROJECT_ID}';
​
        $client = new CodemashClient($secretKey, $projectId);
        $codemashPushNotification = new CodemashPushNotification($client);
    }
    
    public function updateDeviceMeta()
    {
        $responseData = $this->codemashPushNotification->updateDeviceMeta([
            'id' => '{DEVICE_ID}',
            'meta' => ['Brand' => 'Apple'],
        ]);
    }
    
}
patch
Update Device Timezone
https://api.codemash.io/:version/notifications/push/devices/:id/timezone
Updates a timezone of a particular device.
Request
Response
Request
Path Parameters
version
required
string
The version of the API endpoint. Current latest v1.
id
required
string
The ID of a device to update.
Headers
Authorization
required
string
Your project's secret key.
x-cm-projectid
required
string
Your project's ID. Can be passed as a query parameter.
Body Parameters
timezone
optional
string
The timezone of a device in a tz database format.
Response
200: OK
Returns an ID of created notification group.
{
    Result: ""
}
401: Unauthorized
Returns if the user does not have a valid permission to call this method.
​
500: Internal Server Error
​
.NET
Node
PHP
.NET
var client = new CodeMashClient(apiKey, projectId);
var pushService = new CodeMashPushService(client);
​
var response = await pushService.UpdateDeviceTimeZoneAsync(
    new UpdateDeviceTimeZoneRequest
    {
        Id = "{DEVICE_ID}",
        TimeZone = "Etc/UTC",
    }
);
Node
​
PHP
class CodemashService
{
    protected CodemashPushNotification $codemashPushNotification;
​
    public function __construct()
    {
        $secretKey = '{YOUR_SECRET_KEY}';
        $projectId = '{YOUR_PROJECT_ID}';
​
        $client = new CodemashClient($secretKey, $projectId);
        $codemashPushNotification = new CodemashPushNotification($client);
    }
    
    public function updateDeviceTimezone()
    {
        $responseData = $this->codemashPushNotification->updateDeviceTimezone([
            'id' => '{DEVICE_ID}',
            'timezone' => 'ETC/UTC',
        ]);
    }
    
}
patch
Update Device User
https://api.codemash.io/:version/notifications/push/devices/:id/timezone
Updates a user of a particular device.
Request
Response
Request
Path Parameters
version
required
string
The version of the API endpoint. Current latest v1.
id
required
string
The ID of a device to update.
Headers
Authorization
required
string
Your project's secret key.
x-cm-projectid
required
string
Your project's ID. Can be passed as a query parameter.
Body Parameters
userId
optional
string
The ID of a new user.
Response
200: OK
Returns an ID of created notification group.
{
    Result: ""
}
401: Unauthorized
Returns if the user does not have a valid permission to call this method.
​
500: Internal Server Error
​
.NET
Node
PHP
.NET
var client = new CodeMashClient(apiKey, projectId);
var pushService = new CodeMashPushService(client);
​
var response = await pushService.UpdateDeviceUserRequest(
    new UpdateDeviceUserRequest
    {
        Id = "{DEVICE_ID}",
        UserId = Guid.Parse("{USER_ID}"),
    }
);
Node
​
PHP
class CodemashService
{
    protected CodemashPushNotification $codemashPushNotification;
​
    public function __construct()
    {
        $secretKey = '{YOUR_SECRET_KEY}';
        $projectId = '{YOUR_PROJECT_ID}';
​
        $client = new CodemashClient($secretKey, $projectId);
        $codemashPushNotification = new CodemashPushNotification($client);
    }
    
    public function updateDeviceUser()
    {
        $responseData = $this->codemashPushNotification->updateDeviceUser([
            'id' => '{DEVICE_ID}',
            'userId' => '{USER_ID}',
        ]);
    }
    
}
Devices
Next - APIs
Membership API
Last updated 3 months ago
Devices API

postRegister Device

postRegister Expo Token

getGet Device

getGet Devices

deleteDelete Device

deleteDelete Device Token

patchUpdate Device Meta

patchUpdate Device Timezone

patchUpdate Device User

post
Register Device

post
Register Expo Token

get
Get Device

get
Get Devices

delete
Delete Device

delete
Delete Device Token

patch
Update Device Meta

patch
Update Device Timezone

patch
Update Device User
