Florality

PATCH

/api/v1/terminology/scoped

terminology: read_write1,000 requests/minute/key · all plans

Active API keys: Free 1, Pro 5, Pro+ 5. The request rate is the same on every plan.

Parameters

No path or query parameters.

Request body

application/json · required

Unknown properties are rejected.

Name	Type	Required	Description
`sideSystemId`	`string (uuid)`	Required	Side System Id.
`subSystemId`	`string (uuid) \| null`	Optional	Sub System Id.
`terms`	`object`	Required	Terms.
`terms.actions`	`object \| null`	Optional	Actions.
`terms.actions.archiveMember`	`string`	Optional	Archive Member.
`terms.actions.archivedMembers`	`string`	Optional	Archived Members.
`terms.actions.trash`	`string`	Optional	Trash.
`terms.actions.deleteMember`	`string`	Optional	Delete Member.
`terms.actions.permanentlyDeleteMember`	`string`	Optional	Permanently Delete Member.
`terms.actions.unarchiveMember`	`string`	Optional	Unarchive Member.
`terms.actions.restoreFromTrash`	`string`	Optional	Restore From Trash.
`terms.actions.mostFronted`	`string`	Optional	Most Fronted.
`terms.icons`	`object \| null`	Optional	Icons.
`terms.icons.trash`	`string`	Optional	Trash.
`terms.icons.analyticsTotalSessions`	`string`	Optional	Analytics Total Sessions.
`terms.icons.analyticsTotalDuration`	`string`	Optional	Analytics Total Duration.
`terms.icons.analyticsTopSessions`	`string`	Optional	Analytics Top Sessions.
`terms.icons.analyticsTopDuration`	`string`	Optional	Analytics Top Duration.

Response schema

200

Successful response.

Name	Type	Required	Description
`scope`	`object`	Required	Scope.
`scope.kind`	`string`	Required	Kind.
`scope.sideSystemId`	`string`	Optional	Side System Id.
`scope.subSystemId`	`string`	Optional	Sub System Id.
`hasSideOverride`	`boolean`	Required	Has Side Override.
`hasSubOverride`	`boolean`	Required	Has Sub Override.
`_id`	`string`	Required	Unique identifier.
`_creationTime`	`number`	Required	_creation Time.
`userId`	`string`	Required	Owning account identifier.
`terms`	`object`	Required	Terms.
`terms.system`	`object`	Required	System.
`terms.system.singular`	`string`	Required	Singular.
`terms.system.plural`	`string`	Required	Plural.
`terms.member`	`object`	Required	Member.
`terms.member.singular`	`string`	Required	Singular.
`terms.member.plural`	`string`	Required	Plural.
`terms.folder`	`object`	Required	Folder.
`terms.folder.singular`	`string`	Required	Singular.
`terms.folder.plural`	`string`	Required	Plural.
`terms.note`	`object`	Required	Note.
`terms.note.singular`	`string`	Required	Singular.
`terms.note.plural`	`string`	Required	Plural.
`terms.front`	`object`	Required	Front.
`terms.front.singular`	`string`	Required	Singular.
`terms.front.plural`	`string`	Required	Plural.
`terms.group`	`object`	Required	Group.
`terms.group.singular`	`string`	Required	Singular.
`terms.group.plural`	`string`	Required	Plural.
`terms.friend`	`object`	Required	Friend.
`terms.friend.singular`	`string`	Required	Singular.
`terms.friend.plural`	`string`	Required	Plural.
`terms.privacyBucket`	`object`	Required	Privacy Bucket.
`terms.privacyBucket.singular`	`string`	Required	Singular.
`terms.privacyBucket.plural`	`string`	Required	Plural.
`terms.customField`	`object`	Required	Custom Field.
`terms.customField.singular`	`string`	Required	Singular.
`terms.customField.plural`	`string`	Required	Plural.
`terms.sideSystem`	`object`	Required	Side System.
`terms.sideSystem.singular`	`string`	Required	Singular.
`terms.sideSystem.plural`	`string`	Required	Plural.
`terms.subSystem`	`object`	Required	Sub System.
`terms.subSystem.singular`	`string`	Required	Singular.
`terms.subSystem.plural`	`string`	Required	Plural.
`actions`	`object`	Required	Actions.
`actions.archiveMember`	`string`	Required	Archive Member.
`actions.archivedMembers`	`string`	Required	Archived Members.
`actions.trash`	`string`	Required	Trash.
`actions.deleteMember`	`string`	Required	Delete Member.
`actions.permanentlyDeleteMember`	`string`	Required	Permanently Delete Member.
`actions.unarchiveMember`	`string`	Required	Unarchive Member.
`actions.restoreFromTrash`	`string`	Required	Restore From Trash.
`actions.mostFronted`	`string`	Required	Most Fronted.
`icons`	`object`	Required	Icons.
`icons.trash`	`string`	Required	Trash.
`icons.analyticsTotalSessions`	`string`	Required	Analytics Total Sessions.
`icons.analyticsTotalDuration`	`string`	Required	Analytics Total Duration.
`icons.analyticsTopSessions`	`string`	Required	Analytics Top Sessions.
`icons.analyticsTopDuration`	`string`	Required	Analytics Top Duration.
`updatedAt`	`number`	Required	Most recent update time.

Errors

400 · JSON error: Invalid JSON body.
401 · JSON error: Missing or invalid API key. Use Authorization: Bearer <token>.
403 · JSON error: Requires terminology: read_write; ownership or feature restrictions may also deny access.
429 · JSON error: API rate limit exceeded (1000 requests per minute). Retry shortly.

Request example

Set FLORALITY_KEY in your environment. These examples use demo identifiers.

Shell

curl --request PATCH 'https://floralitys.com/api/v1/terminology/scoped' \
  --header "Authorization: Bearer $FLORALITY_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "sideSystemId": "11111111-1111-4111-8111-111111111111",
  "terms": {
    "actions": null,
    "icons": null
  }
}'

Responses

Successful response.

JSON

{
  "scope": {
    "kind": "sub",
    "sideSystemId": "11111111-1111-4111-8111-111111111111",
    "subSystemId": "11111111-1111-4111-8111-111111111111"
  },
  "hasSideOverride": false,
  "hasSubOverride": false,
  "_id": "11111111-1111-4111-8111-111111111111",
  "_creationTime": 1767225600000,
  "userId": "11111111-1111-4111-8111-111111111111",
  "terms": {
    "system": {
      "singular": "demo",
      "plural": "demo"
    },
    "member": {
      "singular": "demo",
      "plural": "demo"
    },
    "folder": {
      "singular": "demo",
      "plural": "demo"
    },
    "note": {
      "singular": "demo",
      "plural": "demo"
    },
    "front": {
      "singular": "demo",
      "plural": "demo"
    },
    "group": {
      "singular": "demo",
      "plural": "demo"
    },
    "friend": {
      "singular": "demo",
      "plural": "demo"
    },
    "privacyBucket": {
      "singular": "demo",
      "plural": "demo"
    },
    "customField": {
      "singular": "demo",
      "plural": "demo"
    },
    "sideSystem": {
      "singular": "demo",
      "plural": "demo"
    },
    "subSystem": {
      "singular": "demo",
      "plural": "demo"
    }
  },
  "actions": {
    "archiveMember": "demo",
    "archivedMembers": "demo",
    "trash": "demo",
    "deleteMember": "demo",
    "permanentlyDeleteMember": "demo",
    "unarchiveMember": "demo",
    "restoreFromTrash": "demo",
    "mostFronted": "demo"
  },
  "icons": {
    "trash": "demo",
    "analyticsTotalSessions": "demo",
    "analyticsTotalDuration": "demo",
    "analyticsTopSessions": "demo",
    "analyticsTopDuration": "demo"
  },
  "updatedAt": 1767225600000
}

Example values are illustrative demo data.

Request body

application/json · required

Unknown properties are rejected.

Name	Type	Required	Description
`sideSystemId`	`string (uuid)`	Required	Side System Id.
`subSystemId`	`string (uuid) \| null`	Optional	Sub System Id.
`terms`	`object`	Required	Terms.
`terms.actions`	`object \| null`	Optional	Actions.
`terms.actions.archiveMember`	`string`	Optional	Archive Member.
`terms.actions.archivedMembers`	`string`	Optional	Archived Members.
`terms.actions.trash`	`string`	Optional	Trash.
`terms.actions.deleteMember`	`string`	Optional	Delete Member.
`terms.actions.permanentlyDeleteMember`	`string`	Optional	Permanently Delete Member.
`terms.actions.unarchiveMember`	`string`	Optional	Unarchive Member.
`terms.actions.restoreFromTrash`	`string`	Optional	Restore From Trash.
`terms.actions.mostFronted`	`string`	Optional	Most Fronted.
`terms.icons`	`object \| null`	Optional	Icons.
`terms.icons.trash`	`string`	Optional	Trash.
`terms.icons.analyticsTotalSessions`	`string`	Optional	Analytics Total Sessions.
`terms.icons.analyticsTotalDuration`	`string`	Optional	Analytics Total Duration.
`terms.icons.analyticsTopSessions`	`string`	Optional	Analytics Top Sessions.
`terms.icons.analyticsTopDuration`	`string`	Optional	Analytics Top Duration.

Response schema

200

Successful response.

Name	Type	Required	Description
`scope`	`object`	Required	Scope.
`scope.kind`	`string`	Required	Kind.
`scope.sideSystemId`	`string`	Optional	Side System Id.
`scope.subSystemId`	`string`	Optional	Sub System Id.
`hasSideOverride`	`boolean`	Required	Has Side Override.
`hasSubOverride`	`boolean`	Required	Has Sub Override.
`_id`	`string`	Required	Unique identifier.
`_creationTime`	`number`	Required	_creation Time.
`userId`	`string`	Required	Owning account identifier.
`terms`	`object`	Required	Terms.
`terms.system`	`object`	Required	System.
`terms.system.singular`	`string`	Required	Singular.
`terms.system.plural`	`string`	Required	Plural.
`terms.member`	`object`	Required	Member.
`terms.member.singular`	`string`	Required	Singular.
`terms.member.plural`	`string`	Required	Plural.
`terms.folder`	`object`	Required	Folder.
`terms.folder.singular`	`string`	Required	Singular.
`terms.folder.plural`	`string`	Required	Plural.
`terms.note`	`object`	Required	Note.
`terms.note.singular`	`string`	Required	Singular.
`terms.note.plural`	`string`	Required	Plural.
`terms.front`	`object`	Required	Front.
`terms.front.singular`	`string`	Required	Singular.
`terms.front.plural`	`string`	Required	Plural.
`terms.group`	`object`	Required	Group.
`terms.group.singular`	`string`	Required	Singular.
`terms.group.plural`	`string`	Required	Plural.
`terms.friend`	`object`	Required	Friend.
`terms.friend.singular`	`string`	Required	Singular.
`terms.friend.plural`	`string`	Required	Plural.
`terms.privacyBucket`	`object`	Required	Privacy Bucket.
`terms.privacyBucket.singular`	`string`	Required	Singular.
`terms.privacyBucket.plural`	`string`	Required	Plural.
`terms.customField`	`object`	Required	Custom Field.
`terms.customField.singular`	`string`	Required	Singular.
`terms.customField.plural`	`string`	Required	Plural.
`terms.sideSystem`	`object`	Required	Side System.
`terms.sideSystem.singular`	`string`	Required	Singular.
`terms.sideSystem.plural`	`string`	Required	Plural.
`terms.subSystem`	`object`	Required	Sub System.
`terms.subSystem.singular`	`string`	Required	Singular.
`terms.subSystem.plural`	`string`	Required	Plural.
`actions`	`object`	Required	Actions.
`actions.archiveMember`	`string`	Required	Archive Member.
`actions.archivedMembers`	`string`	Required	Archived Members.
`actions.trash`	`string`	Required	Trash.
`actions.deleteMember`	`string`	Required	Delete Member.
`actions.permanentlyDeleteMember`	`string`	Required	Permanently Delete Member.
`actions.unarchiveMember`	`string`	Required	Unarchive Member.
`actions.restoreFromTrash`	`string`	Required	Restore From Trash.
`actions.mostFronted`	`string`	Required	Most Fronted.
`icons`	`object`	Required	Icons.
`icons.trash`	`string`	Required	Trash.
`icons.analyticsTotalSessions`	`string`	Required	Analytics Total Sessions.
`icons.analyticsTotalDuration`	`string`	Required	Analytics Total Duration.
`icons.analyticsTopSessions`	`string`	Required	Analytics Top Sessions.
`icons.analyticsTopDuration`	`string`	Required	Analytics Top Duration.
`updatedAt`	`number`	Required	Most recent update time.

Errors

400 · JSON error

Invalid JSON body.

401 · JSON error

Missing or invalid API key. Use Authorization: Bearer <token>.

403 · JSON error

Requires terminology: read_write; ownership or feature restrictions may also deny access.

429 · JSON error

API rate limit exceeded (1000 requests per minute). Retry shortly.

Request example

Set FLORALITY_KEY in your environment. These examples use demo identifiers.

Shell

curl --request PATCH 'https://floralitys.com/api/v1/terminology/scoped' \
  --header "Authorization: Bearer $FLORALITY_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "sideSystemId": "11111111-1111-4111-8111-111111111111",
  "terms": {
    "actions": null,
    "icons": null
  }
}'

Responses

Successful response.

JSON

{
  "scope": {
    "kind": "sub",
    "sideSystemId": "11111111-1111-4111-8111-111111111111",
    "subSystemId": "11111111-1111-4111-8111-111111111111"
  },
  "hasSideOverride": false,
  "hasSubOverride": false,
  "_id": "11111111-1111-4111-8111-111111111111",
  "_creationTime": 1767225600000,
  "userId": "11111111-1111-4111-8111-111111111111",
  "terms": {
    "system": {
      "singular": "demo",
      "plural": "demo"
    },
    "member": {
      "singular": "demo",
      "plural": "demo"
    },
    "folder": {
      "singular": "demo",
      "plural": "demo"
    },
    "note": {
      "singular": "demo",
      "plural": "demo"
    },
    "front": {
      "singular": "demo",
      "plural": "demo"
    },
    "group": {
      "singular": "demo",
      "plural": "demo"
    },
    "friend": {
      "singular": "demo",
      "plural": "demo"
    },
    "privacyBucket": {
      "singular": "demo",
      "plural": "demo"
    },
    "customField": {
      "singular": "demo",
      "plural": "demo"
    },
    "sideSystem": {
      "singular": "demo",
      "plural": "demo"
    },
    "subSystem": {
      "singular": "demo",
      "plural": "demo"
    }
  },
  "actions": {
    "archiveMember": "demo",
    "archivedMembers": "demo",
    "trash": "demo",
    "deleteMember": "demo",
    "permanentlyDeleteMember": "demo",
    "unarchiveMember": "demo",
    "restoreFromTrash": "demo",
    "mostFronted": "demo"
  },
  "icons": {
    "trash": "demo",
    "analyticsTotalSessions": "demo",
    "analyticsTotalDuration": "demo",
    "analyticsTopSessions": "demo",
    "analyticsTopDuration": "demo"
  },
  "updatedAt": 1767225600000
}

Example values are illustrative demo data.

Update scoped terminology

Parameters

Request body

Response schema

200

Errors

Request example

Responses

Update scoped terminology

Parameters

Request body

Response schema

200

Errors

Request example

Responses