Skip to main content

PUT /users/:user_id/tokens/:token

PUThttps://api.courier.com/users/:user_id/tokens/:token
Associate a token with the supplied :user_id. If token exists it's value will be replaced with the passed body, otherwise the token will be created.
PATH PARAMS
user_idstringrequired
The user's ID. This can be any uniquely identifiable string.
tokenstringrequired
The full token string.
BODY PARAM
provider_keystringrequired
The provider token is to be associated with.
propertiesjson
Properties sent to the provider along with the token
deviceobject
Information about the device the token is associated with.
app_idstring
Id of the application the token is used for
ad_idstring
Id of the advertising identifier
device_idstring
Id of the device the token is associated with
platformstring
The device platform i.e. android, ios, web
manufacturerstring
The device manufacturer
modelstring
The device model
trackingobject
Information about the device the token is associated with.
os_versionstring
The operating system version
ipstring
The IP address of the device
latstring
The latitude of the device
longstring
The longitude of the device
expiry_datestring
ISO 8601 formatted date the token expires. Defaults to 2 months. Set to false to disable expiration.
tokenstring
(Optional) Full body of the token. Must match token in URL.
Responses
AUTH TOKEN
curl --request PUT \
--url https://api.courier.com/users/user-1234/tokens/ABW7HO9Y7XAQXZ7Y \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '
{
"provider_key": "firebase-fcm",
"device": {
"app_id": "com.example.app",
"ad_id": "1234567890",
"device_id": "1234567890",
"platform": "android",
"manufacturer": "Samsung",
"model": "SM-G930F"
},
"tracking": {
"os_version": "9",
"ip": "1.2.3.4",
"lat": "1.2",
"long": "3.4"
},
"expiry_date": "2030-01-01T00:00:00.000Z",
"token": "ABW7HO9Y7XAQXZ7Y"
}
'
Response Example
Empty

Examples

  • URL: `/users/user-1234/tokens/ads23fghsdfgsd32
  • Method: PUT
  • Body:
{
"provider_key": "apn",
"properties": {
"is_person": true
},
"device": {
"app_id": "com.my.app",
"platform": "iOS",
"model": "iPhone 13"
}
}