Update Company

Description

This method allows for updating the profile of a currently logged-in company.


Request

Restrictions

This service requires an authenticated user and can only be called after a successful company login.

Endpoint

PUT 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 session. 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

https://<server-url>/api/v3/company?touchpoint=test&token=...

Request Body

The request body should contain the profile and opt-in information to be updated. Only include the fields you wish to change.

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 to manage communication opt-in and opt-out preferences.

JSON

{
  "profile": {
    "name": "New Company Name Inc.",
    "email": "[email protected]",
    "phone": {
      "number": "555-0102",
      "areaCode": "11"
    }
  },
  "optIns": [
    {
      "brandFamilyId": 1,
      "channel": 6001,
      "accepted": false
    }
  ]
}

Response

✅ Successful Response: 200 OK

The company profile has been successfully updated. The response returns the updated session context, including the new profile information.

Last updated

Was this helpful?