Create actors schema

Create an actor schema via API

You can create users schema in Tallyfy Manufactory using the endpoint POST /actors/schema.

Authentication

The following header is required for all API calls:

• X-Manufactory-Auth - Manufactory access token

Required keys

• org_id (required) string - Manufactory org ID.
• project_id (required) number - The project ID associated with this schema.
• attributes (required) object - Pairs containing attribute name and the corresponding data type. A complete list of valid data types.
• unique_id (required) string - The attribute that will be used as a unique ID for a actors profile¹ to differentiate user profiles.

Request example

{
  "org_id": "xyz",
  "unique_id": "email",
  "project_id": 12345,
  "attributes":{
    "City": "TEXT",
    "Country": "TEXT",
    "Email": "TEXT",
    "Username": "TEXT"
  }
}

Response example

{
  "message": "Actors schema created successfully"
}

Related articles

Actors > Get actors schema

The GET endpoint retrieves actor schema details including attribute definitions data types and unique identifiers for a specific project by providing organization ID project ID and authentication token.

Actors > Delete actors schema

The DELETE /actors/schema endpoint allows removal of actor schemas from Tallyfy Manufactory by providing organization ID project ID and authentication token.

Events > Create events schema

Tallyfy Manufactory allows you to create events schemas by sending a POST request to /events/schema with organization ID project ID and attribute definitions using proper authentication headers.

Rest Api > Send events via the REST API

The POST /events endpoint enables sending actor profiles to Tallyfy Manufactory by providing organization ID project ID actor profile object and event attributes with proper schema validation.

Footnotes

1. Must be one of the defined attributes and serves as the primary identifier across all actor records ↩