seedOrganizationData

Requires a tenant administrator.

Loads sample data into the organization, using the organization's own country and currency. A failure is reported in the returned message rather than as an error. Only admins and owners can do this.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation SeedOrganizationData {
  seedOrganizationData {
    message
    success
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation SeedOrganizationData {\n  seedOrganizationData {\n    message\n    success\n  }\n}"
}
EOF

Response:

{
  "data": {
    "seedOrganizationData": {
      "message": "string",
      "success": true
    }
  }
}

seedOrganizationData: SystemActionResponse!

Type

SystemActionResponse object

The result of a system action.