Actions12
Update Schema
AI-generatedSummary
Update the schema of a lead group by adding or modifying fields
Inputs
- schemaGroupId (required) — The ID of the lead group to update schema for
- schemaUpdates (required) — JSON array of schema field updates to apply
- additionalFields — Additional configuration fields such as timeout
- requestOptions — HTTP request options such as batching, proxy, timeout
Output shape
an object indicating success or failure (no body on success)
Success returns HTTP 200 with no payload; errors return an error object with details
Examples
Example 1: Add a status select field and a score number field to a lead group schema
schemaGroupId: cl1234567890; schemaUpdates: [{fieldName:"status",type:"select",options:["new","contacted","qualified","closed"]},{fieldName:"score",type:"number"]}
Example 2: Configure timeout and batching for the update schema request
schemaGroupId: cl1234567890; schemaUpdates: [{fieldName:"status",type:"select",options:["new","contacted","qualified","closed"]}]; additionalFields: {timeout:30000}; requestOptions: {batching:{batchSize:50}}
Example 3: Use a proxy and ignore SSL errors while updating the schema
schemaGroupId: cl1234567890; schemaUpdates: [{fieldName:"score",type:"number"]}; requestOptions: {proxy:"http://myproxy:3128\",allowUnauthorizedCerts:true}