Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated after enabling SMS-verified numbers to be updated
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:
Status
colourGreen
titlePUT
URL:

/user/dp-key/{dp-key}/data/{contract-id}

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

 

 

dp-key

dialogportal™ master key that uniquely identifies account to update

 ext-keyExternal key that uniquely identifies 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:
{
	"name": "John Doe",
	"email": "mailbox@mailserver.com"
}

Span
stylewhite-space:pre
Response body:

 None 
Status codes:

200

Account was successfully updated with success
 400

Request is valid but data validation failed

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

400.2Email address is not unique

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

unique
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