Register Company

Description

This service registers a new company and, upon successful registration, logs it in. This method is used for direct registration without using social network connectors.


Request

Restrictions

This service can only be called when a company is not already logged in.

Endpoint

POST https://<server-url>/api/v4/company

Parameters

Parameter
Location
Description

touchpoint

Query / Header

The identifier for the touchpoint. Use Thalamus-Touchpoint for the header.

token

Query / Header

The authentication token for the API. Use Thalamus-Token for the header.

activity

Query / Header

Optional. The activity to be used. Use Thalamus-Activity for the header.

Content-Type

Header

Specifies the content type of the request body. Must be application/json.

Full URL Example

Request Body

The request body must contain the profile information, credentials, and any communication opt-ins for the new company.

Field
Type
Description

profile

Object

An object containing the company's profile data. For a full list of available fields, see the Get Profile Fields document.

optIns

Array

An array of opt-in objects for communication channels.

ownerPartnerPrincipal

String

Optional. The principal identifier of an existing partner to associate this new company with. The system validates that the principal exists and belongs to a partner.

credential

Object

An object containing the login credentials for the new company. See structure below.

credential Object Fields

Field
Type
Description

principal

String

The primary identifier for login (e.g., email, username). Must match the corresponding principal field in the profile object.

password

String

The password for the new company.

JSON


Response

✅ Successful Response: 201 Created

The company is successfully created and logged in. The response returns the new session context, including profile information and available activities.

Last updated

Was this helpful?