Deactivate a customer

ExpressDeactivateResponse Express.Deactivate(, )

POST/v1/express/{expressCustomerId}/deactivate

Deactivates a customer, preventing it from being used for new studies or user assignments. Existing data is preserved and the customer can be reactivated later.

ParametersExpand Collapse

ExpressDeactivateParams parameters

required string expressCustomerID

Unique Express customer identifier. Format: cus_{32-hex-chars}

ReturnsExpand Collapse

class ExpressDeactivateResponse:

An Express customer entity that groups users and studies

required DateTimeOffset? CreatedAt

Timestamp when the Express customer was created

formatdate-time

required string ExpressCustomerID

Unique Express customer identifier. Format: cus_{32-hex-chars}

required string ExpressCustomerName

Name of the Express customer

minLength1

required Boolean IsActive

Whether the Express customer is currently active

required DateTimeOffset? UpdatedAt

Timestamp when the Express customer was last updated

formatdate-time

required Long UserCount

Number of users currently in this Express customer

minimum0

string CreatedByApiKeyID

UUID of the API key used to create this Express customer, for audit tracking

formatuuid

string CreatedByUserID

User ID who created this Express customer via dashboard, null if created via API key

IReadOnlyDictionary<string, string> Metadata

Custom key-value metadata for the Express customer. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars

Deactivate a customer

ExpressDeactivateParams parameters = new()
{
    ExpressCustomerID = "cus_1234567890abcdef1234567890abcdef"
};

var response = await client.Express.Deactivate(parameters);

Console.WriteLine(response);

{
  "createdAt": "2024-01-15T09:00:00Z",
  "expressCustomerId": "cus_1234567890abcdef1234567890abcdef",
  "expressCustomerName": "City Medical Center - Radiology Department",
  "isActive": true,
  "updatedAt": "2024-03-15T14:20:00Z",
  "userCount": 15,
  "createdByApiKeyId": "550e8400-e29b-41d4-a716-446655440000",
  "createdByUserId": "usr_1234567890abcdef1234567890abcdef",
  "metadata": {
    "department": "radiology",
    "region": "northeast"
  }
}

Returns Examples

{
  "createdAt": "2024-01-15T09:00:00Z",
  "expressCustomerId": "cus_1234567890abcdef1234567890abcdef",
  "expressCustomerName": "City Medical Center - Radiology Department",
  "isActive": true,
  "updatedAt": "2024-03-15T14:20:00Z",
  "userCount": 15,
  "createdByApiKeyId": "550e8400-e29b-41d4-a716-446655440000",
  "createdByUserId": "usr_1234567890abcdef1234567890abcdef",
  "metadata": {
    "department": "radiology",
    "region": "northeast"
  }
}