How to: Create a Participant Type

2min

For information about prerequisites, see Creating Participants.
Assuming there are no Participants in the system, the first Participant that you need to create is a Participant Tenant. The Participant Tenant can be the owner of any other Participant. The Participant type request takes a singular and plural name for the Participant. For the Tenant Participant, which is also the master Participant, both the singular and plural names are the same. Let's create the tenant Participant and call it a vehicle.
To create a Tenant Participant type, call the Create Participant Type endpoint and pass a request body similar to the following:
After the Participant of type Tenant is created, you can create the other Participant types that are going to be part of the operations.
The next Participant type to create is a type that you can use to represent all the mobile devices that the organization owns.
To create the mobile device Participant type, call the Create Participant Type endpoint and pass a request body similar to the following:
Create Participant Type Request Body
{
  "name": {
    "singular": "car",
    "plural": "cars"
  },
  "alias": {
    "singular": "automobile",
    "plural": "automobiles"
  },
  "category": [
    {
      "name": "sedan",
      "description": "a passenger vehicle with four doors",
      "subCategory": [
        "compact",
        "mid-size",
        "full-size"
      ]
    }
  ],
  "allowedOwner": {
    "oneOf": [
      "vendors",
      "users"
    ],
    "not": [
      "vehicle"
    ]
  },
  "entityCode": "CAR001",
  "callback": {
    "url": "https://example.com/callback",
    "meta": {
      "apiKey": "abcdef123456",
      "notificationPreference": "email"
    }
  },
  "enableOrchestrator": true
}
{
  "name": {
    "singular": "car",
    "plural": "cars"
  },
  "alias": {
    "singular": "automobile",
    "plural": "automobiles"
  },
  "category": [
    {
      "name": "sedan",
      "description": "a passenger vehicle with four doors",
      "subCategory": [
        "compact",
        "mid-size",
        "full-size"
      ]
    }
  ],
  "allowedOwner": {
    "oneOf": [
      "vendors",
      "users"
    ],
    "not": [
      "vehicle"
    ]
  },
  "entityCode": "CAR001",
  "callback": {
    "url": "https://example.com/callback",
    "meta": {
      "apiKey": "abcdef123456",
      "notificationPreference": "email"
    }
  },
  "enableOrchestrator": true
}
﻿
📘 Note﻿
By default, all of the tenants that have been initialized already have a tenant participant type created so the above step can be skipped unless you are working with a tenant and initializing it from scratch.
﻿

Updated 31 May 2024

Did this page help you?

Integrate with Participants

Update Attributes and State with a Single API