Unique Coordinate updates
User this API to push coordinates to be updated for a given job seeker or any other user. Coordinates could be phone number, email, Unique Messenger id (Whatsapp number, FB messenger id, telegram id)
Push Coordinates
POST
https://svk2a7wbej.execute-api.us-east-1.amazonaws.com/prod/
This endpoint allows you to push new coordinates and update the subscription to existing one.
Query Parameters
data
object
Data is the object that would be updated for this coordinate. This must include following fields:
1. coordinates : eg: phone number or email or onesignal id.
2. coordinates_type : Phone or Email or Onesignal player ID or other services unique id.
3. user_code : The User id of the user sending this data.
4. user_type: Could be 'JobSeeker', 'Company', 'Admin'. Only one of the three values.
5.user_type_code : If this is for a Job seeker then Job seeker id.
6. name : Name of the job seeker or user.
7. tenant_key : same as tenant id.
8. subscribed : True or false.
With an optional field of 'meta'. Within meta fields you can supply any key value pairs to be stored for that coordinate.
Example:
"data": {
"user_type": "JobSeeker",
"name": "John Doe",
"user_code": 23,
"user_type_code": 414, "coordinates": "12345678901234", "coordinates_type": "Onesignal", "tenant_key": "alpha_db", "subscribed": false,
"meta" : {
"device_id" : "abcdefg",
"other_meta_data" : "optional"
}
}
coordinates must be a unique id for that coordinates type. If a user exists with that coordinate and coordinate type combination, we will override it with the new information.
It must
If any of the above mentioned data is missing the API may reject the update.
key_action
string
Must be: update_coordinates
tenant
string
Unique Tenant Key provided. Usually ends with '_db'
api_key
string
This is the Platform's unique API token.
Headers
Authentication
string
Send Platforms unique API key.
Here is a sample Request body:
Last updated
Was this helpful?