(Incoming) Update - mobile app

This event is sent to your server when a player try to update a contact from the mobile application.

WebSocket event

Event name: contacts@update

⚠️ Response required / expires after 60 seconds

Key	Type	Description
`custom_id`	string	Unique identifier from your services (1-64 characters)
`contact_uid`	string	Unique contact identifier that need to be updated (1-32 characters)
`contact`	IncomingContactPayload	Contact payload with updated data

You need to emit an event with the following name and data:

Response event name: contacts@update/response

Key	Type	Extra	Description
`custom_id`	string	required	Unique identifier from your services (1-64 characters)
`contact`	Contact	required	contact object

Important

Response object must respect every type rule. If any structure isn't respected, your request will be rejected for "bad-request".

I received a request for the following custom_id = 1234 and contact_number = "555-6671"

My response will be:

{
  "custom_id": "1234",
  "contact": {
    "uid": "8756",
    "displayName": "Hank <3",
    "number": "555-6671"
  }
}

You must notify iPear if the data does not comply with your verification processes. Response Error event name: contacts@update/error

Key	Type	Extra	Description
`custom_id`	string	required	Unique identifier from your services (1-64 characters)
`contact_uid`	Contact	required	Unique id of the contact to update (1-32 characters)
`error`	string (Error list)	required	Available errors for this case: `player-not-found`, `contact-not-found`, `contact-already-exist`, `unknown`

My player with the following ID: 1234 has no contact details with the UID 8756

{
  "custom_id": "1234",
  "contact_uid": "8756",
  "error": "contact-not-found"
}

Incoming events

Outgoing events