removedInput schema / properties / changes
Removed value: -{
- "description": "The records to change or make, at most 25.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "clear": {
- "description": "Field keys to empty; only fields describe_record_type marks clearable.",
- "items": {
- "maxLength": 80,
- "type": "string"
- },
- "maxItems": 40,
- "minItems": 1,
- "type": "array"
- },
- "id": {
- "description": "The id of the record to change. Leave it out to make a new record.",
- "maxLength": 200,
- "type": "string"
- },
- "set": {
- "additionalProperties": true,
- "description": "Field keys as describe_record_type names them (email, phone, address.city) and their new values. A money field takes a number.",
- "type": "object"
- },
- "type": {
- "description": "The record type, as list_ai_systems lists it: contact, opportunity, invoice, estimate, job, appointment.",
- "maxLength": 40,
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- "maxItems": 25,
- "minItems": 1,
- "type": "array"
-}
addedInput schema / properties / items
Added value: +{
+ "description": "One object per record, at most 25, with the values the action takes.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "at": {
+ "description": "add_note: When the note is from, ISO 8601 in UTC; now when left out.",
+ "maxLength": 40,
+ "type": "string"
+ },
+ "clear": {
+ "description": "set_fields: field keys to empty; only fields describe_record_type marks clearable.",
+ "items": {
+ "maxLength": 80,
+ "type": "string"
+ },
+ "maxItems": 40,
+ "minItems": 1,
+ "type": "array"
+ },
+ "done": {
+ "description": "add_task: True for a task that is already done.",
+ "type": "boolean"
+ },
+ "due_at": {
+ "description": "add_task: When it is due, ISO 8601 in UTC.",
+ "maxLength": 40,
+ "type": "string"
+ },
+ "fields": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "update_fields: Field names and their new values as text; an empty text empties a field.",
+ "type": "object"
+ },
+ "id": {
+ "description": "The id of the record in the system. Leave it out only with set_fields, to make a new record.",
+ "maxLength": 200,
+ "type": "string"
+ },
+ "notes": {
+ "description": "add_task: More text on the task.",
+ "maxLength": 10000,
+ "type": "string"
+ },
+ "other_id": {
+ "description": "link_records, unlink_records: The id of the second record in the system.",
+ "maxLength": 200,
+ "type": "string"
+ },
+ "other_type": {
+ "description": "link_records, unlink_records: The type of the second record.",
+ "enum": [
+ "contact",
+ "opportunity",
+ "invoice",
+ "estimate",
+ "job",
+ "appointment"
+ ],
+ "type": "string"
+ },
+ "pipeline": {
+ "description": "move_stage: The id of the pipeline, only when the stage is in another pipeline than the record's.",
+ "maxLength": 200,
+ "type": "string"
+ },
+ "priority": {
+ "description": "add_task: How urgent it is.",
+ "enum": [
+ "low",
+ "medium",
+ "high"
+ ],
+ "type": "string"
+ },
+ "set": {
+ "additionalProperties": true,
+ "description": "set_fields: field keys as describe_record_type names them (email, phone, address.city) and their new values. A money field takes a number.",
+ "type": "object"
+ },
+ "stage": {
+ "description": "move_stage: The id of the stage to move to, as describe_record_type gives it with include stages.",
+ "maxLength": 200,
+ "type": "string"
+ },
+ "subject": {
+ "description": "add_task: The title of the task.",
+ "maxLength": 400,
+ "type": "string"
+ },
+ "task_kind": {
+ "description": "add_task: What kind of task it is.",
+ "enum": [
+ "call",
+ "email",
+ "todo"
+ ],
+ "type": "string"
+ },
+ "text": {
+ "description": "add_note: The text of the note.",
+ "maxLength": 10000,
+ "type": "string"
+ },
+ "type": {
+ "description": "The record type; link_records and unlink_records also take note or task as the first record.",
+ "enum": [
+ "contact",
+ "opportunity",
+ "invoice",
+ "estimate",
+ "job",
+ "appointment",
+ "note",
+ "task",
+ "call",
+ "meeting",
+ "email"
+ ],
+ "type": "string"
+ },
+ "user": {
+ "description": "add_note: The id of the user shown as its writer, as describe_record_type gives it with include users. add_task: The id of the user the task is for, as describe_record_type gives it with include users.",
+ "maxLength": 200,
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ "maxItems": 25,
+ "minItems": 1,
+ "type": "array"
+}