Skip to main content
PUT
/
api
/
organizations
/
{organizationId}
/
extraction-rules
Update extraction rules
curl --request PUT \
  --url https://your-instance.example.com/api/organizations/{organizationId}/extraction-rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "builtInFields": {
    "province": {
      "mode": "allowlist",
      "values": [
        "ON",
        "QC",
        "BC",
        "AB"
      ],
      "regex": []
    }
  },
  "customFields": {
    "creditScore": null
  }
}
'
{
  "success": true,
  "message": "Extraction rules updated",
  "data": {
    "builtInFields": {
      "province": {
        "mode": "allowlist",
        "values": [
          "ON",
          "QC"
        ],
        "regex": []
      }
    },
    "customFields": {}
  }
}

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

organizationId
string
required

Query Parameters

type
string
default:Contact

Body

application/json
builtInFields
object

Only allowed when type=Contact. Keys must be one of the built-in extraction field names; pass an empty / null rule to clear.

customFields
object

Custom field keys (must exist in DynamicProperties for the given type).

Response

Extraction rules updated

success
enum<boolean>
Available options:
true
message
string
data
object