Sign up| Sign in

home news setup features pricing company

Update

back to API list

This method updates your account based on the provided properties.

URL

https://api.plupper.com/resources/provider/<providerId>

Formats

plain text

HTTP Method

PUT

Requires Authentication

HTTP BASIC

API rate limited

No

Parameters

• email Required - Your contact email address
• name Optional - Company name (your name)
• displayName Optional - Name which is shown in chats
• welcomeMessage Optional - Message which is shown when the chat window opens and the operator is on-line
• offlineMessage Optional - Message which is shown when the chat window opens and all operators are off-line
• color Optional - HEX format e.g. #32575e - Color of the chat window
• enableChat Optional - boolean value (true/false) - Enable or disable the "Chat" tab in the plupper widget
• enableIdeas Optional - boolean value (true/false) - Enable or disable the "Share Idea" tab in the plupper widget
• enableProblems Optional - boolean value (true/false)- Enable or disable the "Report Problem" tab in the plupper widget
• enableEmail Optional- boolean value (true/false) - Enable or disable the "Email Us" tab in the plupper widget
• enableFaq Optional - boolean value (true/false)- Enable or disable the "FAQ" tab in the plupper widget
• offlineMsgToEmail Optional - boolean value (true/false) - Enables forwarding of all messages to email while the account is off-line.

Response

200 OK

Example queries

• PUT https://api.plupper.com/resources/provider/123
• jQuery example

  $.ajax({
      type: "PUT",
      url: "https://api.plupper.com/resources/provider",
      username: "john.lennon@example.com",
      password: "mysecret",
      data: ({
          welcomeMessage: "New welcome message",
          enableFaq: false
      }),
      success: function() {
          alert("Updated");
      }
  });