v1

latestOpenAPI 3.0.1Apache 2.02026-07-1398228598.3 KB

Field Configuration

Create Field Configuration

Creates a new field configuration owned by the authenticated organization. The owning organization is inferred from the API key and any organization UUID supplied on the body is ignored.

post/field-configurations

Request body

namestring required

Human-readable name of the configuration. Trimmed; 1-128 characters.

teamsUUIDstring[]

UUIDs of the teams to assign this configuration to. Ignored when allTeams is true.

allTeamsboolean

When true, the configuration applies to every team in the organization.

Example request

{
  "name": "Enterprise Discovery Questions",
  "teamsUUID": [
    "fe515723-fe2e-4959-a5fa-c4d3937fe7e4"
  ],
  "allTeams": false,
  "criteria": {
    "conditions": [
      {
        "field": "account.industry",
        "value": "technology"
      }
    ],
    "operator": "AND"
  }
}

Response

Field configuration created successfully.

Example response

{
  "data": {
    "uuid": "b9e1c0a0-5a3d-4a9c-9b1e-2d6f4b7a1c11",
    "name": "Enterprise Discovery Questions",
    "organizationUUID": "16b78cec-82ef-46d2-8213-5d3bb7d2571c",
    "teamsUUID": [
      "fe515723-fe2e-4959-a5fa-c4d3937fe7e4"
    ],
    "allTeams": false,
    "isDefaultTemplate": false
  }
}