Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Excerpt

Validates that the data complies with possible rules and performs the update if it does. Only the data provided in the payload is updated. The calling application must have permission to update accounts.

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 
Status
colourGreen
titlePUT
URL:

/userentity/dp-keyid/{dpentity-keyid}/data/{contract-id}

/userentity/ext-key/{ext-key}/{ext-type}/data/{contract-id}

 


 

dp-key

dialogportal™ master key entity-id

Rubiq entity ID that uniquely identifies an account to update


 ext-keyExternal key that uniquely identifies an account to update 

ext-typeType 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.

Code Block
titleExample 1 - Contract specifies full name and email. Password is not updateable according to contract:
{

    "id": 12345,
    "name": "John Doe",
    
"email": "mailbox@mailserver.com"
}



Span
stylewhite-space: pre

Response body:


 None 
Status codes:

204200

Account was

updated with success 

successfully updated

When verification is enabled, the following sub codes may be returned:

200.1A verification request has been dispatched
200.2A verification request has not been dispatched, as the recent verification request limit has been reached
200.3A verification request has not been dispatched, as a previous verification has been sent within the last 2 minutes, or is still being processed.



400

Request is valid but data validation failed

 

When the email address is configured to be unique, the following sub code may be returned:

400.2Email address is not unique

When SMS verification is enabled, the following sub codes may be returned:

400.3Mobile number is not in a valid format
400.4Mobile number is not unique (the mobile number belongs to an active entity - this includes entities that have not yet been verified)
400.5Mobile number is not unique (the mobile number belongs to an inactive entity)



404Account was not found

 

The following sub codes may be returned:

404.1User not found
404.2External user could not be found



412App has no permission to update accounts

...