Sign up| Sign in

home news setup features pricing company

Update

back to API list

This method updates an operator under your account based on the provided parameters.

URL

https://api.plupper.com/resources/operator/<username>

Formats

plain text

HTTP Method

PUT

Requires Authentication

HTTP BASIC

API rate limited

No

Parameters

• password Optional - New password for the account
• departmentId Optional - Department ID to which the operator belongs
• Name Optional - Full name of the operator (eg. John Lennon)
• displayName Optional - Name which will be shown to visitors (eg. John)
• email Optional - Email address of the operator
• welcomeMessage Optional - Message which is shown to the visitor when the chat window opens and the operator is on-line
• offlineMessage Optional - Message which is shown to the visitor when the chat window opens and the operator is off-line

Response

200 OK

Example queries

• PUT https://api.plupper.com/resources/operator/john
• jQuery example

  $.ajax({
      type: "PUT",
      url: "https://api.plupper.com/resources/operator/" + username,
      username: "john.lennon@example.com",
      password: "mysecret",
      data: ({
          password: "JohnNewPassword",
          displayName: "John",
          departmentId: 111,
          name: "John Lennon 2",
          email: "john.lennon@gmail.com",
          welcomeMessage: "new greetings from john"
      }),
      success: function() {
          alert("Updated");
      }
  });