Skip to main content
PUT
/
api
/
organizations
/
sections
/
{id}
Update DynamicProperties sections for an organization
curl --request PUT \
  --url https://your-instance.example.com/api/organizations/sections/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sections": [
    {
      "name": "Personal Information",
      "isHidden": false,
      "properties": {
        "firstName": {
          "name": "First Name",
          "dataType": "string",
          "isHidden": false
        },
        "lastName": {
          "name": "Last Name",
          "dataType": "string",
          "isHidden": false
        }
      }
    }
  ],
  "isForced": false
}
'
{
  "message": "Sections updated successfully",
  "organization": {
    "_id": "5f7b1c2e8a1d4e0012c3b500",
    "organizationId": "5f7b1c2e8a1d4e0012c3b400",
    "type": "Contact"
  },
  "renamedProperties": {
    "firstname": "firstName"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.tetherai.ca/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Query Parameters

type
string
default:Contact

Body

application/json
sections
object[]
required
isForced
boolean

When true, force-removes properties that have data in existing owner documents and unsets fields whose dataType changed.

Response

Sections updated

message
string
organization
object

Updated DynamicProperties document.

renamedProperties
object

Map from old property name to new property name.