Create Or Update User Candidate
Creates a Customer Centre User (UserCandidate) for a given Contact (personId) with the supplied parameters.
If the Customer Centre User already exists for a given Contact, the user is updated with the supplied parameters. NsApiSlow threshold: 2000 ms.
Headers
Convert string references and multi-language values into a specified language (iso2) code.
Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
Specify the timezone code that you would like date/time responses converted to.
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.
Body
PersonId, Username, AccessAllRequests
CreateOrUpdateUserCandidate: Creates a Customer Centre User (UserCandidate) for a given Contact (personId) with the supplied parameters. If the Customer Centre User already exists for a given Contact, the user is updated with the supplied parameters.
Response
OK
The UserCandidate carrier is used to represent a Customer Centre User. Carrier object for UserCandidate.
Primary key
Foreign key. Id of a person representing Customer Center User.
Username of a Customer Centre User.
Password of a Customer Centre User.
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Field property dictionary mapping field names to field access rights.
Related topics
user_candidate tableGet User Candidate By PersonCreate and update customersProtected tablesCreate and update requests