DELETE_engage_sites_operators_{operatorId}

Delete Operator

DELETE /engage/sites/operators/{operatorId}

This API deletes a SiteAdmin, Manager, or Operator from a site. A SiteAdmin may delete any other role (SiteAdmin, Manager, or Operator). A Manager may only delete an Operator. An Operator does not have privileges to delete others.

This API can only be accessed with a partner account type. ENGAGE managed login types are not able to access this API.

NOTE: The SAM API’s, ENGAGE MAPP, and ENGAGE Web APP will not allow access to a user that is not associated with any site, even if the Basic Auth, or log in credentials are valid for that user. It is therefore recommended to not delete the last site that you are a SiteAdmin on until you have created at least one new site that you are an authorized SiteAdmin, Manager, or Operator.

Authentication

Basic Authentication, must be a partner managed account type

URI Parameters

  • operatorId = string (required)

    • OperatorId is a unique 64 bit integer value on a per site basis. Therefore, the same user will have a different OperatorId for each site: they are an “Operator”, “Manager”, or “SiteAdmin”

Body Parameters

  • NONE

Example request

DELETE /engage/sites/operators/14830 HTTP/1.1

Host: partner.lockwebserv.com

Content-Type: application/json

Authorization: Basic c2l0ZUFkbWluQHNvZnR3YXJlLmNvbTpFTkdBR0UxMjM0NTY=

Response

HTTP status code 204

  • No Content

HTTP status code 403

  • Forbidden – The role of the authenticated user does not allow this action. (Role is specific to the same site of the operator being deleted.)

HTTP status code 404

  • Not Found – The operator with the id provided is not found.