1003: Update account data
- Troels Nielsen
- Nick Jensen
When a "verified" data field is updated (for example, the mobile number for an SMS-verified account), a new verification will be triggered. The field will not be changed to the updated value until the verification is completed by calling endpoint 2004: Verify account
| Endpoint ID: | 1003Â | |||||||||
| Method: | PUT | |||||||||
| URL: | /entity/id/{entity-id}/data/{contract-id} /entity/ext-key/{ext-key}/{ext-type}/data/{contract-id} | |||||||||
entity-id | Rubiq entity ID that uniquely identifies an account to update | |||||||||
| ext-key | External key that uniquely identifies an account to update | |||||||||
| ext-type | Type of external key | |||||||||
| contract-id | Identifies the set of contract fields passed in the request body. If omitted, the default contract for the particular app is used. | |||||||||
| Request body: | JSON data with properties corresponding to the fields in the specified contract. Only the fields included in the JSON payload is affected. Any omitted fields are left unchanged. Example 1 - Contract specifies full name and email. Password is not updateable according to contract: {
"id": 12345,
"name": "John Doe",
"email": "mailbox@mailserver.com"
}
| |||||||||
Response body: |  None | |||||||||
| Status codes: | 200 | Account was successfully updated When verification is enabled, the following sub codes may be returned:
| ||||||||
| 400 | Request is valid but data validation failed When the email address is configured to be unique, the following sub code may be returned:
When SMS verification is enabled, the following sub codes may be returned:
| |||||||||
| 404 | Account was not found The following sub codes may be returned:
| |||||||||
| 412 | App has no permission to update accounts | |||||||||