Update a trader's field by your own customer ID
The single-field update API can find a trader by your own customer ID, and bulk updates accept ISO 8601 date-times.
01 ·The single-field update API finds traders by your customer ID
Bulk updates and the Update User API already accept the broker's own customer ID. The API call that writes one value to a trader's user field now does too, finding the trader through the field the community has set as its external identifier. The caller switches this on with an option in the call. Without it, the lookup and the responses stay as they were. The ID is matched exactly as sent, after trimming spaces, so case and leading zeros count.
The call writes nothing and returns an error naming the reason when:
- the community has no external identifier field set
- no single trader can be found for that customer ID
- the lookup is temporarily unavailable, in which case the call can be retried
A call that finds the trader by customer ID cannot change that ID. Changes to it go through Update User.
A broker's systems can update a trader's field in real time with the same customer ID the Update User API accepts, so they do not need to look up the platform's own user ID first.
Bulk updates accept ISO 8601 date-times for date-time fields, with or without milliseconds and a time zone offset, and read a value with no offset as UTC. The single-field update API also accepts milliseconds, and the older DD/MM/YYYY, HH:mm format still works in bulk updates.
30 Sep