Sample Data

This endpoint creates sample data for trial organizations as part of the Sample data Opt-In functionality.

This endpoint creates sample data for the organization based on the requested resource types.

Supported resource types:

  • users: Creates 6 sample users (2 activated, 2 staged, 2 suspended) with varying attributes
  • usergroups: Creates a dynamic user group that automatically includes users in the Sales department

Each resource type is processed independently. If one fails, others may still succeed. The response includes detailed results showing what was created, skipped, or failed.

post/api/v2/sample-data

Request

Request body

resourceTypesstring[] required

Array of resource types to create. Each resource type is processed independently.

Example request

{
  "resourceTypes": [
    "users",
    "usergroups"
  ]
}

Response

OK

messagestring

Response message describing the outcome.

Example response

{
  "message": "Sample data created successfully."
}

Changes

No recorded changes to this operation across all 1 revision of this API.