[COMMAND]

Deactivating an Operator

The provisioning_deactivate command can be used to deactivate an operator account, making it unavailable for use but preserving associated data for future reporting.

To identify the operator, you will need to specify either:

  • Its id.
  • Its external_id and external_id_type (if applicable).

Parameters

table
required		 string Set this to "vcc_operators".
id
optional		 string

The unique ID automatically assigned to the intended operator when it was created.

If you prefer to identify the operator using its third party external_id, this parameter is not needed.
external_id
optional		 string

An ID used by a third-party to identify the data. If used, an external_id_type should also be specified.
external_id_type
optional		 string

If an external_id applies to this operation, specify the third party to whom that ID belongs, e.g. "omniconsumerproducts".
request_id
optional		 string

If specified, this value will be returned as part of the response event. It can be used to help a calling application associate a request with its response.

Example Request

Copy 
{"command":{"command_type":"provisioning_deactivate", "table":"vcc_operators", "external_id":10101, "external_id_type":"bigtimegames"}}

Responses

On Success:

After a successful deactivation, a provisioning_values event is returned containing details of the deactivated operator.

On Failure:

Failure to complete this command will cause a provisioning_error event, containing a description of what went wrong.