v28

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-013593344.3 KB
Users
Organizations

Create or Update an Organization

Group your users by company, team, or any organizational structure that makes sense for your business.

Provide an externalOrganizationId to identify the organization—your ID from your own system. Don't worry about whether it already exists; we'll create it if it's new or update it if it already exists. This makes syncing organization data effortless.

Reference this organization when creating users (via /users) or logging messages (via /messages) using the same externalOrganizationId. Perfect for B2B products where you need to track which company each user belongs to.

post/organizations

Request body

externalOrganizationIdstring required

Your unique identifier for the organization. Use this same ID in other API calls to reference this organization.

namestring

The organization's name.

propertiesobject

Custom organization properties.

Response

Organization created or updated successfully

successboolean required

Whether the API call was successful.