post
https://public-api.vibescm.com/mobile_apps//devices//assign
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Before you start...Before you get started, we recommend review the Associate Person to Device customer API in the Vibes Push SDK section to understand how and when this API call should be used.
Response
If the call is successful, the response will include the newly associated person entity. Now that the vibes_device_id and external_device_id are associated, you can use person data to target push messaging to the user’s push device.
Notes:
- If a
person_keyis supplied, and a person with thatperson_keydoes not exist, that will result in an error. - If an
external_person_idis supplied and a person with thatexternal_person_iddoes not exist, then theexternal_person_idwill be assigned to the person currently associated with the device. - If the indicated person exists and the device is not already associated with them, it will be moved to be associated with them.
- If the indicated person is already associated with the device, then nothing will be done and a success response will be returned.
In the case of an error, a standard public API error response will be returned instead. See Responses below for some common errors.
The vibes_device_id or person_key (if provided) could not be found.
Unprocessible entity. The requested assignment could not be completed. Reason will be stated in the response body.