{ "server": { "name": "Broadcast (formerly Call Loop) Public API", "version": "latest", "transport": "http" }, "capabilities": { "tools": { "delete_assets": { "name": "delete_assets", "description": "Delete assets", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "assetIds": { "type": "array", "items": { "$ref": "#/definitions/__schema0" }, "description": "IDs of assets to delete" } }, "required": [ "assetIds" ], "definitions": { "__schema0": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } } } }, "list_assets": { "name": "list_assets", "description": "List assets", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "page": { "default": 0, "description": "Zero-based page index (0..N)", "allOf": [ { "$ref": "#/definitions/__schema0" } ] }, "size": { "default": 20, "description": "The size of the page to be returned", "allOf": [ { "$ref": "#/definitions/__schema1" } ] }, "sort": { "type": "array", "items": { "$ref": "#/definitions/__schema2" }, "description": "Sort as property,asc or property,desc. Example: createdAt,desc. An unknown property or direction returns HTTP 400." } }, "definitions": { "__schema0": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "__schema1": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "__schema2": { "type": "string" } } } }, "upload_an_asset_from_a_url": { "name": "upload_an_asset_from_a_url", "description": "Upload an asset from a URL", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "url": { "type": "string" } }, "additionalProperties": {} } }, "required": [ "body" ] } }, "delete_audio_files": { "name": "delete_audio_files", "description": "Delete audio files", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "ids": { "type": "array", "items": { "$ref": "#/definitions/__schema0" }, "description": "IDs of audio files to delete" } }, "required": [ "ids" ], "definitions": { "__schema0": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } } } }, "list_audio_files": { "name": "list_audio_files", "description": "List audio files", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "pattern": { "type": "string", "description": "Optional audio name filter" }, "page": { "default": 0, "description": "Zero-based page index (0..N)", "allOf": [ { "$ref": "#/definitions/__schema0" } ] }, "size": { "default": 20, "description": "The size of the page to be returned", "allOf": [ { "$ref": "#/definitions/__schema1" } ] }, "sort": { "type": "array", "items": { "$ref": "#/definitions/__schema2" }, "description": "Sort as property,asc or property,desc. Example: createdAt,desc. An unknown property or direction returns HTTP 400." } }, "definitions": { "__schema0": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "__schema1": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "__schema2": { "type": "string" } } } }, "update_an_audio_file": { "name": "update_an_audio_file", "description": "Update an audio file", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "id": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "name": { "type": "string" } }, "additionalProperties": {} } }, "required": [ "body" ] } }, "check_if_an_audio_name_exists": { "name": "check_if_an_audio_name_exists", "description": "Check if an audio name exists", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "name": { "type": "string", "description": "Audio file name" } }, "required": [ "name" ] } }, "replace_an_audio_file": { "name": "replace_an_audio_file", "description": "Replace an audio file", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "fileInfo.audioId": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "ID of the existing audio item. Send as the form field fileInfo.audioId." }, "body": { "type": "object", "properties": { "file": { "type": "string", "description": "Replacement audio file. Supported file extensions: mp3, wav." } }, "required": [ "file" ], "additionalProperties": {} } }, "required": [ "fileInfo.audioId" ] } }, "upload_an_audio_file": { "name": "upload_an_audio_file", "description": "Upload an audio file", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "file": { "type": "string", "description": "Audio file. Supported file extensions: mp3, wav." } }, "required": [ "file" ], "additionalProperties": {} } } } }, "delete_contact_cards": { "name": "delete_contact_cards", "description": "Delete contact cards", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "cardIds": { "type": "array", "items": { "$ref": "#/definitions/__schema0" }, "description": "IDs of contact cards to delete" } }, "required": [ "cardIds" ], "definitions": { "__schema0": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } } } }, "list_contact_cards": { "name": "list_contact_cards", "description": "List contact cards", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "page": { "default": 0, "description": "Zero-based page index (0..N)", "allOf": [ { "$ref": "#/definitions/__schema0" } ] }, "size": { "default": 20, "description": "The size of the page to be returned", "allOf": [ { "$ref": "#/definitions/__schema1" } ] }, "sort": { "type": "array", "items": { "$ref": "#/definitions/__schema2" }, "description": "Sort as property,asc or property,desc. Example: createdAt,desc. An unknown property or direction returns HTTP 400." } }, "definitions": { "__schema0": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "__schema1": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "__schema2": { "type": "string" } } } }, "create_a_contact_card": { "name": "create_a_contact_card", "description": "Create a contact card", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "name": { "type": "string" }, "tagline": { "type": "string" }, "phoneNumber": { "type": "string" }, "website": { "type": "string" }, "email": { "type": "string" }, "street": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zipCode": { "type": "string" }, "countryCode": { "type": "string" }, "facebookUrl": { "type": "string" }, "twitterUrl": { "type": "string" }, "instagramUrl": { "type": "string" }, "linkedinUrl": { "type": "string" }, "youtubeUrl": { "type": "string" } }, "additionalProperties": {} } }, "required": [ "body" ] } }, "update_a_contact_card": { "name": "update_a_contact_card", "description": "Update a contact card", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "contactCardId": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Contact card ID" }, "body": { "type": "object", "properties": { "name": { "type": "string" }, "tagline": { "type": "string" }, "phoneNumber": { "type": "string" }, "website": { "type": "string" }, "email": { "type": "string" }, "street": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zipCode": { "type": "string" }, "countryCode": { "type": "string" }, "facebookUrl": { "type": "string" }, "twitterUrl": { "type": "string" }, "instagramUrl": { "type": "string" }, "linkedinUrl": { "type": "string" }, "youtubeUrl": { "type": "string" } }, "additionalProperties": {} } }, "required": [ "contactCardId", "body" ] } }, "delete_contacts": { "name": "delete_contacts", "description": "Delete contacts", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "contactIds": { "type": "array", "items": { "$ref": "#/definitions/__schema0" }, "description": "IDs of contacts to delete" } }, "required": [ "contactIds" ], "definitions": { "__schema0": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } } } }, "list_organization_contacts": { "name": "list_organization_contacts", "description": "List organization contacts", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "status": { "type": "string", "enum": [ "Active", "Inactive", "Archived", "Invalid", "Unsubscribed", "Deleted", "Dnc" ], "example": "Active", "description": "Contact lifecycle filter (`Active`, `Archived`, …). Not a message delivery status." }, "searchPattern": { "type": "string" }, "subscriptionStates": { "type": "array", "items": { "type": "string", "enum": [ "SUBSCRIBED", "HARD_UNSUBSCRIBED", "SOFT_UNSUBSCRIBED", "RE_SUBSCRIBED" ] } }, "callSubscriptionStates": { "type": "array", "items": { "type": "string", "enum": [ "SUBSCRIBED", "HARD_UNSUBSCRIBED", "SOFT_UNSUBSCRIBED", "RE_SUBSCRIBED" ] } }, "excludedListIds": { "type": "array", "items": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "excludedContactIds": { "type": "array", "items": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "page": { "default": 0, "description": "Zero-based page index (0..N)", "allOf": [ { "$ref": "#/definitions/__schema0" } ] }, "size": { "default": 20, "description": "Number of contacts per page. Default: 20. Max: 250.", "allOf": [ { "$ref": "#/definitions/__schema1" } ] }, "sort": { "type": "array", "items": { "$ref": "#/definitions/__schema2" }, "description": "Sort as property,asc or property,desc. Example: createdAt,desc. An unknown property or direction returns HTTP 400." } }, "definitions": { "__schema0": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "__schema1": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "__schema2": { "type": "string" } } } }, "create_a_contact": { "name": "create_a_contact", "description": "Create a contact", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "phoneNumber": { "type": "string", "description": "Contact phone number. Required on create and full update; optional on patch. Prefer E.164 (`+15551234567`); national US format is accepted." }, "timeZoneType": { "type": "string", "enum": [ "EASTERN", "EAST_INDIANA", "MICHIGAN", "CENTRAL", "MOUNTAIN", "ARIZONA", "PACIFIC", "ALASKA", "HAWAII", "ATLANTIC", "NEWFOUNDLAND", "SASKATCHEWAN", "UNDEFINED" ] }, "customFields": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": {} } }, "listIds": { "type": "array", "items": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } } }, "additionalProperties": {} } }, "required": [ "body" ] } }, "get_active_contacts_count_for_a_broadcast": { "name": "get_active_contacts_count_for_a_broadcast", "description": "Get active contacts count for a broadcast", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "filterValue": { "type": "object", "properties": { "sourceFilters": { "$ref": "#/definitions/__schema0" }, "filters": { "$ref": "#/definitions/__schema12" }, "contactIds": { "$ref": "#/definitions/__schema13" }, "listIds": { "$ref": "#/definitions/__schema15" }, "segmentIds": { "$ref": "#/definitions/__schema17" } }, "additionalProperties": { "$ref": "#/definitions/__schema19" }, "example": { "listIds": [ 1 ], "sourceFilters": [ [ { "field": "STATUS", "type": "CONTACT", "dataType": "SELECT", "condition": "IN", "value": "Active", "orIndex": 0, "andIndex": 0 }, { "field": "company_name", "type": "CUSTOM", "dataType": "TEXT", "condition": "CONTAINS_ANY", "value": "Acme", "orIndex": 0, "andIndex": 1 } ] ] } }, "type": { "type": "string", "enum": [ "SMS", "Voice", "Ringless", "None" ] } }, "additionalProperties": {} } }, "required": [ "body" ], "definitions": { "__schema0": { "type": "array", "items": { "$ref": "#/definitions/__schema1" }, "description": "Grouped filters. Each inner list is a group; groups are ORed. Inside a group, same orIndex values are ANDed. Do not send together with filters." }, "__schema1": { "type": "array", "items": { "$ref": "#/definitions/__schema2" } }, "__schema2": { "type": "object", "properties": { "field": { "$ref": "#/definitions/__schema3" }, "value": { "$ref": "#/definitions/__schema4" }, "valueExt": { "$ref": "#/definitions/__schema5" }, "dataType": { "$ref": "#/definitions/__schema6" }, "type": { "$ref": "#/definitions/__schema7" }, "condition": { "$ref": "#/definitions/__schema8" }, "orIndex": { "$ref": "#/definitions/__schema9" }, "andIndex": { "$ref": "#/definitions/__schema10" } }, "additionalProperties": { "$ref": "#/definitions/__schema11" }, "description": "A single contact filter condition." }, "__schema3": { "type": "string", "example": "FIRST_NAME" }, "__schema4": { "type": "string", "example": "Jane" }, "__schema5": { "type": "string", "description": "Second bound for BETWEEN / NOT_BETWEEN date filters. Omit otherwise." }, "__schema6": { "type": "string", "enum": [ "LIST", "SEGMENT", "PHONE", "TEXT", "URL", "BOOLEAN", "NUMBER", "CURRENCY", "SELECT", "DATE_TIME", "DATE" ] }, "__schema7": { "type": "string", "enum": [ "CONTACT", "CUSTOM", "ACTIVITY", "LOOKUP", "SEGMENTS" ] }, "__schema8": { "type": "string", "enum": [ "EXISTS", "NOT_EXISTS", "IN", "NOT_IN", "CONTAINS_ANY", "CONTAINS_NONE", "STARTS_WITH_ANY", "ENDS_WITH_ANY", "BEFORE", "ON", "AFTER", "BETWEEN", "NOT_BETWEEN", "EQ", "NOT_EQ", "LESS", "LESS_EQ", "GREATER", "GREATER_EQ" ] }, "__schema9": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "example": 0 }, "__schema10": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "example": 0 }, "__schema11": {}, "__schema12": { "type": "array", "items": { "$ref": "#/definitions/__schema2" }, "description": "Flat filter list. AND/OR is expressed with orIndex/andIndex. Do not send together with sourceFilters." }, "__schema13": { "type": "array", "items": { "$ref": "#/definitions/__schema14" }, "description": "Explicit contact IDs to include." }, "__schema14": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema15": { "type": "array", "items": { "$ref": "#/definitions/__schema16" }, "description": "Contact list IDs to include." }, "__schema16": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema17": { "type": "array", "items": { "$ref": "#/definitions/__schema18" }, "description": "Segment IDs to include." }, "__schema18": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema19": {} } } }, "add_contacts_to_lists": { "name": "add_contacts_to_lists", "description": "Add contacts to lists", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "listIds": { "type": "array", "items": { "$ref": "#/definitions/__schema0" }, "description": "List IDs" }, "body": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "searchPattern": { "type": "string" }, "filter": { "type": "object", "properties": { "sourceFilters": { "$ref": "#/definitions/__schema1" }, "filters": { "$ref": "#/definitions/__schema13" }, "contactIds": { "$ref": "#/definitions/__schema14" }, "listIds": { "$ref": "#/definitions/__schema16" }, "segmentIds": { "$ref": "#/definitions/__schema18" } }, "additionalProperties": { "$ref": "#/definitions/__schema20" }, "example": { "listIds": [ 1 ], "sourceFilters": [ [ { "field": "STATUS", "type": "CONTACT", "dataType": "SELECT", "condition": "IN", "value": "Active", "orIndex": 0, "andIndex": 0 }, { "field": "company_name", "type": "CUSTOM", "dataType": "TEXT", "condition": "CONTAINS_ANY", "value": "Acme", "orIndex": 0, "andIndex": 1 } ] ] } }, "listId": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "Active", "Inactive", "Archived", "Invalid", "Unsubscribed", "Deleted", "Dnc" ], "example": "Active" } }, "additionalProperties": {} } }, "required": [ "listIds", "body" ], "definitions": { "__schema0": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema1": { "type": "array", "items": { "$ref": "#/definitions/__schema2" }, "description": "Grouped filters. Each inner list is a group; groups are ORed. Inside a group, same orIndex values are ANDed. Do not send together with filters." }, "__schema2": { "type": "array", "items": { "$ref": "#/definitions/__schema3" } }, "__schema3": { "type": "object", "properties": { "field": { "$ref": "#/definitions/__schema4" }, "value": { "$ref": "#/definitions/__schema5" }, "valueExt": { "$ref": "#/definitions/__schema6" }, "dataType": { "$ref": "#/definitions/__schema7" }, "type": { "$ref": "#/definitions/__schema8" }, "condition": { "$ref": "#/definitions/__schema9" }, "orIndex": { "$ref": "#/definitions/__schema10" }, "andIndex": { "$ref": "#/definitions/__schema11" } }, "additionalProperties": { "$ref": "#/definitions/__schema12" }, "description": "A single contact filter condition." }, "__schema4": { "type": "string", "example": "FIRST_NAME" }, "__schema5": { "type": "string", "example": "Jane" }, "__schema6": { "type": "string", "description": "Second bound for BETWEEN / NOT_BETWEEN date filters. Omit otherwise." }, "__schema7": { "type": "string", "enum": [ "LIST", "SEGMENT", "PHONE", "TEXT", "URL", "BOOLEAN", "NUMBER", "CURRENCY", "SELECT", "DATE_TIME", "DATE" ] }, "__schema8": { "type": "string", "enum": [ "CONTACT", "CUSTOM", "ACTIVITY", "LOOKUP", "SEGMENTS" ] }, "__schema9": { "type": "string", "enum": [ "EXISTS", "NOT_EXISTS", "IN", "NOT_IN", "CONTAINS_ANY", "CONTAINS_NONE", "STARTS_WITH_ANY", "ENDS_WITH_ANY", "BEFORE", "ON", "AFTER", "BETWEEN", "NOT_BETWEEN", "EQ", "NOT_EQ", "LESS", "LESS_EQ", "GREATER", "GREATER_EQ" ] }, "__schema10": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "example": 0 }, "__schema11": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "example": 0 }, "__schema12": {}, "__schema13": { "type": "array", "items": { "$ref": "#/definitions/__schema3" }, "description": "Flat filter list. AND/OR is expressed with orIndex/andIndex. Do not send together with sourceFilters." }, "__schema14": { "type": "array", "items": { "$ref": "#/definitions/__schema15" }, "description": "Explicit contact IDs to include." }, "__schema15": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema16": { "type": "array", "items": { "$ref": "#/definitions/__schema17" }, "description": "Contact list IDs to include." }, "__schema17": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema18": { "type": "array", "items": { "$ref": "#/definitions/__schema19" }, "description": "Segment IDs to include." }, "__schema19": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema20": {} } } }, "bulk_archive_contacts": { "name": "bulk_archive_contacts", "description": "Bulk archive contacts", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "searchPattern": { "type": "string" }, "filter": { "type": "object", "properties": { "sourceFilters": { "$ref": "#/definitions/__schema0" }, "filters": { "$ref": "#/definitions/__schema12" }, "contactIds": { "$ref": "#/definitions/__schema13" }, "listIds": { "$ref": "#/definitions/__schema15" }, "segmentIds": { "$ref": "#/definitions/__schema17" } }, "additionalProperties": { "$ref": "#/definitions/__schema19" }, "example": { "listIds": [ 1 ], "sourceFilters": [ [ { "field": "STATUS", "type": "CONTACT", "dataType": "SELECT", "condition": "IN", "value": "Active", "orIndex": 0, "andIndex": 0 }, { "field": "company_name", "type": "CUSTOM", "dataType": "TEXT", "condition": "CONTAINS_ANY", "value": "Acme", "orIndex": 0, "andIndex": 1 } ] ] } }, "listId": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "Active", "Inactive", "Archived", "Invalid", "Unsubscribed", "Deleted", "Dnc" ], "example": "Active" } }, "additionalProperties": {} } }, "required": [ "body" ], "definitions": { "__schema0": { "type": "array", "items": { "$ref": "#/definitions/__schema1" }, "description": "Grouped filters. Each inner list is a group; groups are ORed. Inside a group, same orIndex values are ANDed. Do not send together with filters." }, "__schema1": { "type": "array", "items": { "$ref": "#/definitions/__schema2" } }, "__schema2": { "type": "object", "properties": { "field": { "$ref": "#/definitions/__schema3" }, "value": { "$ref": "#/definitions/__schema4" }, "valueExt": { "$ref": "#/definitions/__schema5" }, "dataType": { "$ref": "#/definitions/__schema6" }, "type": { "$ref": "#/definitions/__schema7" }, "condition": { "$ref": "#/definitions/__schema8" }, "orIndex": { "$ref": "#/definitions/__schema9" }, "andIndex": { "$ref": "#/definitions/__schema10" } }, "additionalProperties": { "$ref": "#/definitions/__schema11" }, "description": "A single contact filter condition." }, "__schema3": { "type": "string", "example": "FIRST_NAME" }, "__schema4": { "type": "string", "example": "Jane" }, "__schema5": { "type": "string", "description": "Second bound for BETWEEN / NOT_BETWEEN date filters. Omit otherwise." }, "__schema6": { "type": "string", "enum": [ "LIST", "SEGMENT", "PHONE", "TEXT", "URL", "BOOLEAN", "NUMBER", "CURRENCY", "SELECT", "DATE_TIME", "DATE" ] }, "__schema7": { "type": "string", "enum": [ "CONTACT", "CUSTOM", "ACTIVITY", "LOOKUP", "SEGMENTS" ] }, "__schema8": { "type": "string", "enum": [ "EXISTS", "NOT_EXISTS", "IN", "NOT_IN", "CONTAINS_ANY", "CONTAINS_NONE", "STARTS_WITH_ANY", "ENDS_WITH_ANY", "BEFORE", "ON", "AFTER", "BETWEEN", "NOT_BETWEEN", "EQ", "NOT_EQ", "LESS", "LESS_EQ", "GREATER", "GREATER_EQ" ] }, "__schema9": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "example": 0 }, "__schema10": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "example": 0 }, "__schema11": {}, "__schema12": { "type": "array", "items": { "$ref": "#/definitions/__schema2" }, "description": "Flat filter list. AND/OR is expressed with orIndex/andIndex. Do not send together with sourceFilters." }, "__schema13": { "type": "array", "items": { "$ref": "#/definitions/__schema14" }, "description": "Explicit contact IDs to include." }, "__schema14": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema15": { "type": "array", "items": { "$ref": "#/definitions/__schema16" }, "description": "Contact list IDs to include." }, "__schema16": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema17": { "type": "array", "items": { "$ref": "#/definitions/__schema18" }, "description": "Segment IDs to include." }, "__schema18": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema19": {} } } }, "bulk_delete_contacts": { "name": "bulk_delete_contacts", "description": "Bulk delete contacts", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "searchPattern": { "type": "string" }, "filter": { "type": "object", "properties": { "sourceFilters": { "$ref": "#/definitions/__schema0" }, "filters": { "$ref": "#/definitions/__schema12" }, "contactIds": { "$ref": "#/definitions/__schema13" }, "listIds": { "$ref": "#/definitions/__schema15" }, "segmentIds": { "$ref": "#/definitions/__schema17" } }, "additionalProperties": { "$ref": "#/definitions/__schema19" }, "example": { "listIds": [ 1 ], "sourceFilters": [ [ { "field": "STATUS", "type": "CONTACT", "dataType": "SELECT", "condition": "IN", "value": "Active", "orIndex": 0, "andIndex": 0 }, { "field": "company_name", "type": "CUSTOM", "dataType": "TEXT", "condition": "CONTAINS_ANY", "value": "Acme", "orIndex": 0, "andIndex": 1 } ] ] } }, "listId": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "Active", "Inactive", "Archived", "Invalid", "Unsubscribed", "Deleted", "Dnc" ], "example": "Active" } }, "additionalProperties": {} } }, "required": [ "body" ], "definitions": { "__schema0": { "type": "array", "items": { "$ref": "#/definitions/__schema1" }, "description": "Grouped filters. Each inner list is a group; groups are ORed. Inside a group, same orIndex values are ANDed. Do not send together with filters." }, "__schema1": { "type": "array", "items": { "$ref": "#/definitions/__schema2" } }, "__schema2": { "type": "object", "properties": { "field": { "$ref": "#/definitions/__schema3" }, "value": { "$ref": "#/definitions/__schema4" }, "valueExt": { "$ref": "#/definitions/__schema5" }, "dataType": { "$ref": "#/definitions/__schema6" }, "type": { "$ref": "#/definitions/__schema7" }, "condition": { "$ref": "#/definitions/__schema8" }, "orIndex": { "$ref": "#/definitions/__schema9" }, "andIndex": { "$ref": "#/definitions/__schema10" } }, "additionalProperties": { "$ref": "#/definitions/__schema11" }, "description": "A single contact filter condition." }, "__schema3": { "type": "string", "example": "FIRST_NAME" }, "__schema4": { "type": "string", "example": "Jane" }, "__schema5": { "type": "string", "description": "Second bound for BETWEEN / NOT_BETWEEN date filters. Omit otherwise." }, "__schema6": { "type": "string", "enum": [ "LIST", "SEGMENT", "PHONE", "TEXT", "URL", "BOOLEAN", "NUMBER", "CURRENCY", "SELECT", "DATE_TIME", "DATE" ] }, "__schema7": { "type": "string", "enum": [ "CONTACT", "CUSTOM", "ACTIVITY", "LOOKUP", "SEGMENTS" ] }, "__schema8": { "type": "string", "enum": [ "EXISTS", "NOT_EXISTS", "IN", "NOT_IN", "CONTAINS_ANY", "CONTAINS_NONE", "STARTS_WITH_ANY", "ENDS_WITH_ANY", "BEFORE", "ON", "AFTER", "BETWEEN", "NOT_BETWEEN", "EQ", "NOT_EQ", "LESS", "LESS_EQ", "GREATER", "GREATER_EQ" ] }, "__schema9": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "example": 0 }, "__schema10": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "example": 0 }, "__schema11": {}, "__schema12": { "type": "array", "items": { "$ref": "#/definitions/__schema2" }, "description": "Flat filter list. AND/OR is expressed with orIndex/andIndex. Do not send together with sourceFilters." }, "__schema13": { "type": "array", "items": { "$ref": "#/definitions/__schema14" }, "description": "Explicit contact IDs to include." }, "__schema14": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema15": { "type": "array", "items": { "$ref": "#/definitions/__schema16" }, "description": "Contact list IDs to include." }, "__schema16": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema17": { "type": "array", "items": { "$ref": "#/definitions/__schema18" }, "description": "Segment IDs to include." }, "__schema18": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema19": {} } } }, "remove_contacts_from_lists": { "name": "remove_contacts_from_lists", "description": "Remove contacts from lists", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "listIds": { "type": "array", "items": { "$ref": "#/definitions/__schema0" }, "description": "List IDs" }, "body": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "searchPattern": { "type": "string" }, "filter": { "type": "object", "properties": { "sourceFilters": { "$ref": "#/definitions/__schema1" }, "filters": { "$ref": "#/definitions/__schema13" }, "contactIds": { "$ref": "#/definitions/__schema14" }, "listIds": { "$ref": "#/definitions/__schema16" }, "segmentIds": { "$ref": "#/definitions/__schema18" } }, "additionalProperties": { "$ref": "#/definitions/__schema20" }, "example": { "listIds": [ 1 ], "sourceFilters": [ [ { "field": "STATUS", "type": "CONTACT", "dataType": "SELECT", "condition": "IN", "value": "Active", "orIndex": 0, "andIndex": 0 }, { "field": "company_name", "type": "CUSTOM", "dataType": "TEXT", "condition": "CONTAINS_ANY", "value": "Acme", "orIndex": 0, "andIndex": 1 } ] ] } }, "listId": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "Active", "Inactive", "Archived", "Invalid", "Unsubscribed", "Deleted", "Dnc" ], "example": "Active" } }, "additionalProperties": {} } }, "required": [ "listIds", "body" ], "definitions": { "__schema0": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema1": { "type": "array", "items": { "$ref": "#/definitions/__schema2" }, "description": "Grouped filters. Each inner list is a group; groups are ORed. Inside a group, same orIndex values are ANDed. Do not send together with filters." }, "__schema2": { "type": "array", "items": { "$ref": "#/definitions/__schema3" } }, "__schema3": { "type": "object", "properties": { "field": { "$ref": "#/definitions/__schema4" }, "value": { "$ref": "#/definitions/__schema5" }, "valueExt": { "$ref": "#/definitions/__schema6" }, "dataType": { "$ref": "#/definitions/__schema7" }, "type": { "$ref": "#/definitions/__schema8" }, "condition": { "$ref": "#/definitions/__schema9" }, "orIndex": { "$ref": "#/definitions/__schema10" }, "andIndex": { "$ref": "#/definitions/__schema11" } }, "additionalProperties": { "$ref": "#/definitions/__schema12" }, "description": "A single contact filter condition." }, "__schema4": { "type": "string", "example": "FIRST_NAME" }, "__schema5": { "type": "string", "example": "Jane" }, "__schema6": { "type": "string", "description": "Second bound for BETWEEN / NOT_BETWEEN date filters. Omit otherwise." }, "__schema7": { "type": "string", "enum": [ "LIST", "SEGMENT", "PHONE", "TEXT", "URL", "BOOLEAN", "NUMBER", "CURRENCY", "SELECT", "DATE_TIME", "DATE" ] }, "__schema8": { "type": "string", "enum": [ "CONTACT", "CUSTOM", "ACTIVITY", "LOOKUP", "SEGMENTS" ] }, "__schema9": { "type": "string", "enum": [ "EXISTS", "NOT_EXISTS", "IN", "NOT_IN", "CONTAINS_ANY", "CONTAINS_NONE", "STARTS_WITH_ANY", "ENDS_WITH_ANY", "BEFORE", "ON", "AFTER", "BETWEEN", "NOT_BETWEEN", "EQ", "NOT_EQ", "LESS", "LESS_EQ", "GREATER", "GREATER_EQ" ] }, "__schema10": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "example": 0 }, "__schema11": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "example": 0 }, "__schema12": {}, "__schema13": { "type": "array", "items": { "$ref": "#/definitions/__schema3" }, "description": "Flat filter list. AND/OR is expressed with orIndex/andIndex. Do not send together with sourceFilters." }, "__schema14": { "type": "array", "items": { "$ref": "#/definitions/__schema15" }, "description": "Explicit contact IDs to include." }, "__schema15": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema16": { "type": "array", "items": { "$ref": "#/definitions/__schema17" }, "description": "Contact list IDs to include." }, "__schema17": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema18": { "type": "array", "items": { "$ref": "#/definitions/__schema19" }, "description": "Segment IDs to include." }, "__schema19": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema20": {} } } }, "bulk_re_subscribe_contacts": { "name": "bulk_re_subscribe_contacts", "description": "Bulk re-subscribe contacts", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "searchPattern": { "type": "string" }, "filter": { "type": "object", "properties": { "sourceFilters": { "$ref": "#/definitions/__schema0" }, "filters": { "$ref": "#/definitions/__schema12" }, "contactIds": { "$ref": "#/definitions/__schema13" }, "listIds": { "$ref": "#/definitions/__schema15" }, "segmentIds": { "$ref": "#/definitions/__schema17" } }, "additionalProperties": { "$ref": "#/definitions/__schema19" }, "example": { "listIds": [ 1 ], "sourceFilters": [ [ { "field": "STATUS", "type": "CONTACT", "dataType": "SELECT", "condition": "IN", "value": "Active", "orIndex": 0, "andIndex": 0 }, { "field": "company_name", "type": "CUSTOM", "dataType": "TEXT", "condition": "CONTAINS_ANY", "value": "Acme", "orIndex": 0, "andIndex": 1 } ] ] } }, "listId": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "Active", "Inactive", "Archived", "Invalid", "Unsubscribed", "Deleted", "Dnc" ], "example": "Active" } }, "additionalProperties": {} } }, "required": [ "body" ], "definitions": { "__schema0": { "type": "array", "items": { "$ref": "#/definitions/__schema1" }, "description": "Grouped filters. Each inner list is a group; groups are ORed. Inside a group, same orIndex values are ANDed. Do not send together with filters." }, "__schema1": { "type": "array", "items": { "$ref": "#/definitions/__schema2" } }, "__schema2": { "type": "object", "properties": { "field": { "$ref": "#/definitions/__schema3" }, "value": { "$ref": "#/definitions/__schema4" }, "valueExt": { "$ref": "#/definitions/__schema5" }, "dataType": { "$ref": "#/definitions/__schema6" }, "type": { "$ref": "#/definitions/__schema7" }, "condition": { "$ref": "#/definitions/__schema8" }, "orIndex": { "$ref": "#/definitions/__schema9" }, "andIndex": { "$ref": "#/definitions/__schema10" } }, "additionalProperties": { "$ref": "#/definitions/__schema11" }, "description": "A single contact filter condition." }, "__schema3": { "type": "string", "example": "FIRST_NAME" }, "__schema4": { "type": "string", "example": "Jane" }, "__schema5": { "type": "string", "description": "Second bound for BETWEEN / NOT_BETWEEN date filters. Omit otherwise." }, "__schema6": { "type": "string", "enum": [ "LIST", "SEGMENT", "PHONE", "TEXT", "URL", "BOOLEAN", "NUMBER", "CURRENCY", "SELECT", "DATE_TIME", "DATE" ] }, "__schema7": { "type": "string", "enum": [ "CONTACT", "CUSTOM", "ACTIVITY", "LOOKUP", "SEGMENTS" ] }, "__schema8": { "type": "string", "enum": [ "EXISTS", "NOT_EXISTS", "IN", "NOT_IN", "CONTAINS_ANY", "CONTAINS_NONE", "STARTS_WITH_ANY", "ENDS_WITH_ANY", "BEFORE", "ON", "AFTER", "BETWEEN", "NOT_BETWEEN", "EQ", "NOT_EQ", "LESS", "LESS_EQ", "GREATER", "GREATER_EQ" ] }, "__schema9": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "example": 0 }, "__schema10": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "example": 0 }, "__schema11": {}, "__schema12": { "type": "array", "items": { "$ref": "#/definitions/__schema2" }, "description": "Flat filter list. AND/OR is expressed with orIndex/andIndex. Do not send together with sourceFilters." }, "__schema13": { "type": "array", "items": { "$ref": "#/definitions/__schema14" }, "description": "Explicit contact IDs to include." }, "__schema14": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema15": { "type": "array", "items": { "$ref": "#/definitions/__schema16" }, "description": "Contact list IDs to include." }, "__schema16": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema17": { "type": "array", "items": { "$ref": "#/definitions/__schema18" }, "description": "Segment IDs to include." }, "__schema18": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema19": {} } } }, "bulk_soft_unsubscribe_contacts": { "name": "bulk_soft_unsubscribe_contacts", "description": "Bulk soft-unsubscribe contacts", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "searchPattern": { "type": "string" }, "filter": { "type": "object", "properties": { "sourceFilters": { "$ref": "#/definitions/__schema0" }, "filters": { "$ref": "#/definitions/__schema12" }, "contactIds": { "$ref": "#/definitions/__schema13" }, "listIds": { "$ref": "#/definitions/__schema15" }, "segmentIds": { "$ref": "#/definitions/__schema17" } }, "additionalProperties": { "$ref": "#/definitions/__schema19" }, "example": { "listIds": [ 1 ], "sourceFilters": [ [ { "field": "STATUS", "type": "CONTACT", "dataType": "SELECT", "condition": "IN", "value": "Active", "orIndex": 0, "andIndex": 0 }, { "field": "company_name", "type": "CUSTOM", "dataType": "TEXT", "condition": "CONTAINS_ANY", "value": "Acme", "orIndex": 0, "andIndex": 1 } ] ] } }, "listId": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "Active", "Inactive", "Archived", "Invalid", "Unsubscribed", "Deleted", "Dnc" ], "example": "Active" } }, "additionalProperties": {} } }, "required": [ "body" ], "definitions": { "__schema0": { "type": "array", "items": { "$ref": "#/definitions/__schema1" }, "description": "Grouped filters. Each inner list is a group; groups are ORed. Inside a group, same orIndex values are ANDed. Do not send together with filters." }, "__schema1": { "type": "array", "items": { "$ref": "#/definitions/__schema2" } }, "__schema2": { "type": "object", "properties": { "field": { "$ref": "#/definitions/__schema3" }, "value": { "$ref": "#/definitions/__schema4" }, "valueExt": { "$ref": "#/definitions/__schema5" }, "dataType": { "$ref": "#/definitions/__schema6" }, "type": { "$ref": "#/definitions/__schema7" }, "condition": { "$ref": "#/definitions/__schema8" }, "orIndex": { "$ref": "#/definitions/__schema9" }, "andIndex": { "$ref": "#/definitions/__schema10" } }, "additionalProperties": { "$ref": "#/definitions/__schema11" }, "description": "A single contact filter condition." }, "__schema3": { "type": "string", "example": "FIRST_NAME" }, "__schema4": { "type": "string", "example": "Jane" }, "__schema5": { "type": "string", "description": "Second bound for BETWEEN / NOT_BETWEEN date filters. Omit otherwise." }, "__schema6": { "type": "string", "enum": [ "LIST", "SEGMENT", "PHONE", "TEXT", "URL", "BOOLEAN", "NUMBER", "CURRENCY", "SELECT", "DATE_TIME", "DATE" ] }, "__schema7": { "type": "string", "enum": [ "CONTACT", "CUSTOM", "ACTIVITY", "LOOKUP", "SEGMENTS" ] }, "__schema8": { "type": "string", "enum": [ "EXISTS", "NOT_EXISTS", "IN", "NOT_IN", "CONTAINS_ANY", "CONTAINS_NONE", "STARTS_WITH_ANY", "ENDS_WITH_ANY", "BEFORE", "ON", "AFTER", "BETWEEN", "NOT_BETWEEN", "EQ", "NOT_EQ", "LESS", "LESS_EQ", "GREATER", "GREATER_EQ" ] }, "__schema9": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "example": 0 }, "__schema10": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "example": 0 }, "__schema11": {}, "__schema12": { "type": "array", "items": { "$ref": "#/definitions/__schema2" }, "description": "Flat filter list. AND/OR is expressed with orIndex/andIndex. Do not send together with sourceFilters." }, "__schema13": { "type": "array", "items": { "$ref": "#/definitions/__schema14" }, "description": "Explicit contact IDs to include." }, "__schema14": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema15": { "type": "array", "items": { "$ref": "#/definitions/__schema16" }, "description": "Contact list IDs to include." }, "__schema16": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema17": { "type": "array", "items": { "$ref": "#/definitions/__schema18" }, "description": "Segment IDs to include." }, "__schema18": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema19": {} } } }, "bulk_unarchive_contacts": { "name": "bulk_unarchive_contacts", "description": "Bulk unarchive contacts", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "searchPattern": { "type": "string" }, "filter": { "type": "object", "properties": { "sourceFilters": { "$ref": "#/definitions/__schema0" }, "filters": { "$ref": "#/definitions/__schema12" }, "contactIds": { "$ref": "#/definitions/__schema13" }, "listIds": { "$ref": "#/definitions/__schema15" }, "segmentIds": { "$ref": "#/definitions/__schema17" } }, "additionalProperties": { "$ref": "#/definitions/__schema19" }, "example": { "listIds": [ 1 ], "sourceFilters": [ [ { "field": "STATUS", "type": "CONTACT", "dataType": "SELECT", "condition": "IN", "value": "Active", "orIndex": 0, "andIndex": 0 }, { "field": "company_name", "type": "CUSTOM", "dataType": "TEXT", "condition": "CONTAINS_ANY", "value": "Acme", "orIndex": 0, "andIndex": 1 } ] ] } }, "listId": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "Active", "Inactive", "Archived", "Invalid", "Unsubscribed", "Deleted", "Dnc" ], "example": "Active" } }, "additionalProperties": {} } }, "required": [ "body" ], "definitions": { "__schema0": { "type": "array", "items": { "$ref": "#/definitions/__schema1" }, "description": "Grouped filters. Each inner list is a group; groups are ORed. Inside a group, same orIndex values are ANDed. Do not send together with filters." }, "__schema1": { "type": "array", "items": { "$ref": "#/definitions/__schema2" } }, "__schema2": { "type": "object", "properties": { "field": { "$ref": "#/definitions/__schema3" }, "value": { "$ref": "#/definitions/__schema4" }, "valueExt": { "$ref": "#/definitions/__schema5" }, "dataType": { "$ref": "#/definitions/__schema6" }, "type": { "$ref": "#/definitions/__schema7" }, "condition": { "$ref": "#/definitions/__schema8" }, "orIndex": { "$ref": "#/definitions/__schema9" }, "andIndex": { "$ref": "#/definitions/__schema10" } }, "additionalProperties": { "$ref": "#/definitions/__schema11" }, "description": "A single contact filter condition." }, "__schema3": { "type": "string", "example": "FIRST_NAME" }, "__schema4": { "type": "string", "example": "Jane" }, "__schema5": { "type": "string", "description": "Second bound for BETWEEN / NOT_BETWEEN date filters. Omit otherwise." }, "__schema6": { "type": "string", "enum": [ "LIST", "SEGMENT", "PHONE", "TEXT", "URL", "BOOLEAN", "NUMBER", "CURRENCY", "SELECT", "DATE_TIME", "DATE" ] }, "__schema7": { "type": "string", "enum": [ "CONTACT", "CUSTOM", "ACTIVITY", "LOOKUP", "SEGMENTS" ] }, "__schema8": { "type": "string", "enum": [ "EXISTS", "NOT_EXISTS", "IN", "NOT_IN", "CONTAINS_ANY", "CONTAINS_NONE", "STARTS_WITH_ANY", "ENDS_WITH_ANY", "BEFORE", "ON", "AFTER", "BETWEEN", "NOT_BETWEEN", "EQ", "NOT_EQ", "LESS", "LESS_EQ", "GREATER", "GREATER_EQ" ] }, "__schema9": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "example": 0 }, "__schema10": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "example": 0 }, "__schema11": {}, "__schema12": { "type": "array", "items": { "$ref": "#/definitions/__schema2" }, "description": "Flat filter list. AND/OR is expressed with orIndex/andIndex. Do not send together with sourceFilters." }, "__schema13": { "type": "array", "items": { "$ref": "#/definitions/__schema14" }, "description": "Explicit contact IDs to include." }, "__schema14": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema15": { "type": "array", "items": { "$ref": "#/definitions/__schema16" }, "description": "Contact list IDs to include." }, "__schema16": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema17": { "type": "array", "items": { "$ref": "#/definitions/__schema18" }, "description": "Segment IDs to include." }, "__schema18": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema19": {} } } }, "verify_dnc_contacts": { "name": "verify_dnc_contacts", "description": "Verify DNC contacts", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "searchPattern": { "type": "string" }, "filter": { "type": "object", "properties": { "sourceFilters": { "$ref": "#/definitions/__schema0" }, "filters": { "$ref": "#/definitions/__schema12" }, "contactIds": { "$ref": "#/definitions/__schema13" }, "listIds": { "$ref": "#/definitions/__schema15" }, "segmentIds": { "$ref": "#/definitions/__schema17" } }, "additionalProperties": { "$ref": "#/definitions/__schema19" }, "example": { "listIds": [ 1 ], "sourceFilters": [ [ { "field": "STATUS", "type": "CONTACT", "dataType": "SELECT", "condition": "IN", "value": "Active", "orIndex": 0, "andIndex": 0 }, { "field": "company_name", "type": "CUSTOM", "dataType": "TEXT", "condition": "CONTAINS_ANY", "value": "Acme", "orIndex": 0, "andIndex": 1 } ] ] } }, "listId": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "Active", "Inactive", "Archived", "Invalid", "Unsubscribed", "Deleted", "Dnc" ], "example": "Active" } }, "additionalProperties": {} } }, "required": [ "body" ], "definitions": { "__schema0": { "type": "array", "items": { "$ref": "#/definitions/__schema1" }, "description": "Grouped filters. Each inner list is a group; groups are ORed. Inside a group, same orIndex values are ANDed. Do not send together with filters." }, "__schema1": { "type": "array", "items": { "$ref": "#/definitions/__schema2" } }, "__schema2": { "type": "object", "properties": { "field": { "$ref": "#/definitions/__schema3" }, "value": { "$ref": "#/definitions/__schema4" }, "valueExt": { "$ref": "#/definitions/__schema5" }, "dataType": { "$ref": "#/definitions/__schema6" }, "type": { "$ref": "#/definitions/__schema7" }, "condition": { "$ref": "#/definitions/__schema8" }, "orIndex": { "$ref": "#/definitions/__schema9" }, "andIndex": { "$ref": "#/definitions/__schema10" } }, "additionalProperties": { "$ref": "#/definitions/__schema11" }, "description": "A single contact filter condition." }, "__schema3": { "type": "string", "example": "FIRST_NAME" }, "__schema4": { "type": "string", "example": "Jane" }, "__schema5": { "type": "string", "description": "Second bound for BETWEEN / NOT_BETWEEN date filters. Omit otherwise." }, "__schema6": { "type": "string", "enum": [ "LIST", "SEGMENT", "PHONE", "TEXT", "URL", "BOOLEAN", "NUMBER", "CURRENCY", "SELECT", "DATE_TIME", "DATE" ] }, "__schema7": { "type": "string", "enum": [ "CONTACT", "CUSTOM", "ACTIVITY", "LOOKUP", "SEGMENTS" ] }, "__schema8": { "type": "string", "enum": [ "EXISTS", "NOT_EXISTS", "IN", "NOT_IN", "CONTAINS_ANY", "CONTAINS_NONE", "STARTS_WITH_ANY", "ENDS_WITH_ANY", "BEFORE", "ON", "AFTER", "BETWEEN", "NOT_BETWEEN", "EQ", "NOT_EQ", "LESS", "LESS_EQ", "GREATER", "GREATER_EQ" ] }, "__schema9": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "example": 0 }, "__schema10": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "example": 0 }, "__schema11": {}, "__schema12": { "type": "array", "items": { "$ref": "#/definitions/__schema2" }, "description": "Flat filter list. AND/OR is expressed with orIndex/andIndex. Do not send together with sourceFilters." }, "__schema13": { "type": "array", "items": { "$ref": "#/definitions/__schema14" }, "description": "Explicit contact IDs to include." }, "__schema14": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema15": { "type": "array", "items": { "$ref": "#/definitions/__schema16" }, "description": "Contact list IDs to include." }, "__schema16": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema17": { "type": "array", "items": { "$ref": "#/definitions/__schema18" }, "description": "Segment IDs to include." }, "__schema18": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema19": {} } } }, "get_contacts_by_ids": { "name": "get_contacts_by_ids", "description": "Get contacts by IDs", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "contactIds": { "type": "array", "items": { "$ref": "#/definitions/__schema0" }, "description": "Contact IDs" } }, "required": [ "contactIds" ], "definitions": { "__schema0": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } } } }, "get_contacts_by_list_id": { "name": "get_contacts_by_list_id", "description": "Get contacts by list ID", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "listId": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "List ID" }, "status": { "type": "string", "enum": [ "Active", "Inactive", "Archived", "Invalid", "Unsubscribed", "Deleted", "Dnc" ], "example": "Active", "description": "Contact lifecycle filter (`Active`, `Archived`, …). Not a message delivery status." }, "searchPattern": { "type": "string" }, "subscriptionStates": { "type": "array", "items": { "type": "string", "enum": [ "SUBSCRIBED", "HARD_UNSUBSCRIBED", "SOFT_UNSUBSCRIBED", "RE_SUBSCRIBED" ] } }, "callSubscriptionStates": { "type": "array", "items": { "type": "string", "enum": [ "SUBSCRIBED", "HARD_UNSUBSCRIBED", "SOFT_UNSUBSCRIBED", "RE_SUBSCRIBED" ] } }, "excludedListIds": { "type": "array", "items": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "excludedContactIds": { "type": "array", "items": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "page": { "default": 0, "description": "Zero-based page index (0..N)", "allOf": [ { "$ref": "#/definitions/__schema0" } ] }, "size": { "default": 20, "description": "The size of the page to be returned", "allOf": [ { "$ref": "#/definitions/__schema1" } ] }, "sort": { "type": "array", "items": { "$ref": "#/definitions/__schema2" }, "description": "Sort as property,asc or property,desc. Example: createdAt,desc. An unknown property or direction returns HTTP 400." } }, "required": [ "listId" ], "definitions": { "__schema0": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "__schema1": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "__schema2": { "type": "string" } } } }, "preview_contacts_for_campaign_triggers": { "name": "preview_contacts_for_campaign_triggers", "description": "Preview contacts for campaign triggers", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "page": { "default": 0, "description": "Zero-based page index (0..N)", "allOf": [ { "$ref": "#/definitions/__schema0" } ] }, "size": { "default": 20, "description": "The size of the page to be returned", "allOf": [ { "$ref": "#/definitions/__schema1" } ] }, "sort": { "type": "array", "items": { "$ref": "#/definitions/__schema2" }, "description": "Sort as property,asc or property,desc. Example: createdAt,desc. An unknown property or direction returns HTTP 400." }, "body": { "type": "array", "items": { "type": "object", "properties": { "appConfig": { "type": "object", "properties": { "accountIntegrationType": { "type": "string", "enum": [ "ActiveCampaign", "Drip", "Keap", "Custom", "HubSpot", "Zapier", "LeadConnector", "ClickBank", "MailChimp", "Shopify" ] }, "trigger": { "type": "object", "properties": { "triggerType": { "type": "string", "enum": [ "MAILCHIMP_CONTACT_SUBSCRIBED", "CLICK_BANK_TRANSACTION", "CL_EMAIL_CAPTURED", "CL_CONTACT_ADDED_TO_LIST", "CL_CONTACT_REMOVED_FROM_LIST", "CL_CONTACT_UNSUBSCRIBED", "CL_CONTACT_CREATED_OR_UPDATED" ] }, "data": { "type": "object", "properties": {}, "additionalProperties": {} } }, "additionalProperties": {} } }, "additionalProperties": {} }, "webhookConfig": { "type": "object", "properties": { "app": { "type": "string", "enum": [ "ActiveCampaign", "Drip", "Keap", "Custom", "HubSpot", "Zapier", "LeadConnector", "ClickBank", "MailChimp", "Shopify" ] }, "appPhoneField": { "type": "string" }, "link": { "type": "string" } }, "additionalProperties": {} } }, "additionalProperties": {} } } }, "required": [ "body" ], "definitions": { "__schema0": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "__schema1": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "__schema2": { "type": "string" } } } }, "get_a_contact": { "name": "get_a_contact", "description": "Get a contact", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "contactId": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Contact ID" } }, "required": [ "contactId" ] } }, "partially_update_a_contact": { "name": "partially_update_a_contact", "description": "Partially update a contact", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "contactId": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Contact ID" }, "body": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "phoneNumber": { "type": "string", "description": "Contact phone number. Required on create and full update; optional on patch. Prefer E.164 (`+15551234567`); national US format is accepted." }, "timeZoneType": { "type": "string", "enum": [ "EASTERN", "EAST_INDIANA", "MICHIGAN", "CENTRAL", "MOUNTAIN", "ARIZONA", "PACIFIC", "ALASKA", "HAWAII", "ATLANTIC", "NEWFOUNDLAND", "SASKATCHEWAN", "UNDEFINED" ] }, "customFields": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": {} } }, "listIds": { "type": "array", "items": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } } }, "additionalProperties": {} } }, "required": [ "contactId" ] } }, "update_a_contact": { "name": "update_a_contact", "description": "Update a contact", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "contactId": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Contact ID" }, "body": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "phoneNumber": { "type": "string", "description": "Contact phone number. Required on create and full update; optional on patch. Prefer E.164 (`+15551234567`); national US format is accepted." }, "timeZoneType": { "type": "string", "enum": [ "EASTERN", "EAST_INDIANA", "MICHIGAN", "CENTRAL", "MOUNTAIN", "ARIZONA", "PACIFIC", "ALASKA", "HAWAII", "ATLANTIC", "NEWFOUNDLAND", "SASKATCHEWAN", "UNDEFINED" ] }, "customFields": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": {} } }, "listIds": { "type": "array", "items": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } } }, "additionalProperties": {} } }, "required": [ "contactId", "body" ] } }, "re_subscribe_a_contact": { "name": "re_subscribe_a_contact", "description": "Re-subscribe a contact", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "contactId": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Contact ID" } }, "required": [ "contactId" ] } }, "soft_unsubscribe_a_contact": { "name": "soft_unsubscribe_a_contact", "description": "Soft-unsubscribe a contact", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "contactId": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Contact ID" } }, "required": [ "contactId" ] } }, "update_contact_opt_in_status": { "name": "update_contact_opt_in_status", "description": "Update contact opt-in status", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "contactId": { "$ref": "#/definitions/__schema0" }, "textMessageState": { "$ref": "#/definitions/__schema1" }, "callAndRinglessState": { "$ref": "#/definitions/__schema2" } }, "additionalProperties": { "$ref": "#/definitions/__schema3" }, "description": "Contact opt-in status" } }, "required": [ "body" ], "definitions": { "__schema0": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema1": { "type": "string", "enum": [ "SUBSCRIBED", "SOFT_UNSUBSCRIBED" ], "example": "SUBSCRIBED" }, "__schema2": { "type": "string", "enum": [ "SUBSCRIBED", "SOFT_UNSUBSCRIBED" ], "example": "SUBSCRIBED" }, "__schema3": {} } } }, "search_lists_and_contacts": { "name": "search_lists_and_contacts", "description": "Search lists and contacts", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "searchPattern": { "type": "string" }, "excludedListIds": { "type": "array", "items": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "excludedContactIds": { "type": "array", "items": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "excludedSegmentIds": { "type": "array", "items": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } } } } }, "get_organization_contacts_statistics": { "name": "get_organization_contacts_statistics", "description": "Get organization contacts statistics", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": {} } }, "delete_lists": { "name": "delete_lists", "description": "Delete lists", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "listIds": { "type": "array", "items": { "$ref": "#/definitions/__schema0" }, "description": "IDs of lists to delete" } }, "required": [ "listIds" ], "definitions": { "__schema0": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } } } }, "get_organization_lists": { "name": "get_organization_lists", "description": "Get organization lists", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "listingSearch": { "type": "object", "properties": { "searchPattern": { "type": "string" }, "excludedListIds": { "type": "array", "items": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } } }, "additionalProperties": {} }, "selectedFields": { "type": "array", "items": { "$ref": "#/definitions/__schema0" }, "description": "Statistics fields to include" }, "page": { "default": 0, "description": "Zero-based page index (0..N)", "allOf": [ { "$ref": "#/definitions/__schema1" } ] }, "size": { "default": 20, "description": "The size of the page to be returned", "allOf": [ { "$ref": "#/definitions/__schema2" } ] }, "sort": { "type": "array", "items": { "$ref": "#/definitions/__schema3" }, "description": "Sort as property,asc or property,desc. Example: createdAt,desc. An unknown property or direction returns HTTP 400." } }, "required": [ "listingSearch" ], "definitions": { "__schema0": { "type": "string" }, "__schema1": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "__schema2": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "__schema3": { "type": "string" } } } }, "create_a_list": { "name": "create_a_list", "description": "Create a list", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "name": { "type": "string" } }, "additionalProperties": {} } }, "required": [ "body" ] } }, "get_lists_by_ids": { "name": "get_lists_by_ids", "description": "Get lists by IDs", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "ids": { "type": "array", "items": { "$ref": "#/definitions/__schema0" }, "description": "List IDs" } }, "required": [ "ids" ], "definitions": { "__schema0": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } } } }, "update_a_list": { "name": "update_a_list", "description": "Update a list", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "listId": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "List ID" }, "selectedFields": { "type": "array", "items": { "$ref": "#/definitions/__schema0" }, "description": "Statistics fields to include, e.g. totalContactsCount, activeContactsCount" }, "body": { "type": "object", "properties": { "name": { "type": "string" } }, "additionalProperties": {} } }, "required": [ "listId", "body" ], "definitions": { "__schema0": { "type": "string" } } } }, "get_list_contacts_statistics": { "name": "get_list_contacts_statistics", "description": "Get list contacts statistics", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "listId": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "List ID" } }, "required": [ "listId" ] } }, "verify_dnc_contact_lists": { "name": "verify_dnc_contact_lists", "description": "Verify DNC contact lists", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "listIds": { "type": "array", "items": { "$ref": "#/definitions/__schema0" }, "description": "List IDs" } }, "required": [ "listIds" ], "definitions": { "__schema0": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } } } }, "get_a_compliance_message": { "name": "get_a_compliance_message", "description": "Get a compliance message", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": {} } }, "get_a_message_by_numeric_id_or_state_uuid": { "name": "get_a_message_by_numeric_id_or_state_uuid", "description": "Get a message by numeric id or state UUID", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "description": "Message numeric ID or state UUID" } }, "required": [ "id" ] } }, "send_a_ringless_voicemail": { "name": "send_a_ringless_voicemail", "description": "Send a ringless voicemail", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "fromNumber": { "type": "string", "minLength": 1, "description": "Caller ID / from number on your CallLoop account. Prefer E.164 (`+15551234567`). Invalid format returns HTTP 400 (`From number is invalid`)." }, "toNumber": { "type": "string", "minLength": 1, "description": "Destination number. Prefer E.164 (`+15551234567`). Matched or created as a contact. Invalid format returns HTTP 400 (`To number is invalid`)." }, "ringlessMessage": { "type": "object", "properties": { "audioId": { "$ref": "#/definitions/__schema0" }, "callbackEnabled": { "$ref": "#/definitions/__schema1" }, "validOnly": { "$ref": "#/definitions/__schema2" } }, "additionalProperties": { "$ref": "#/definitions/__schema3" }, "description": "Ringless payload. `audioId` must already exist in the account." } }, "required": [ "fromNumber", "toNumber", "ringlessMessage" ], "additionalProperties": {} } }, "required": [ "body" ], "definitions": { "__schema0": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "ID of an existing audio item in the account. Upload audio in CallLoop first; send does not accept files." }, "__schema1": { "type": "boolean" }, "__schema2": { "type": "boolean", "description": "When true, skip sending if the destination contact is on the DNC list (`state.status` = `Skipped`). Default false." }, "__schema3": {} } } }, "send_an_sms_message": { "name": "send_an_sms_message", "description": "Send an SMS message", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "fromNumber": { "type": "string", "minLength": 1, "description": "Caller ID / from number on your CallLoop account. Prefer E.164 (`+15551234567`). Invalid format returns HTTP 400 (`From number is invalid`)." }, "toNumber": { "type": "string", "minLength": 1, "description": "Destination number. Prefer E.164 (`+15551234567`). Matched or created as a contact. Invalid format returns HTTP 400 (`To number is invalid`)." }, "smsMessage": { "type": "object", "properties": { "text": { "$ref": "#/definitions/__schema0" }, "compliance": { "$ref": "#/definitions/__schema1" }, "shortenUrls": { "$ref": "#/definitions/__schema2" }, "validOnly": { "$ref": "#/definitions/__schema3" }, "complianceText": { "$ref": "#/definitions/__schema4" }, "assetIds": { "$ref": "#/definitions/__schema5" }, "cardIds": { "$ref": "#/definitions/__schema7" }, "audioIds": { "$ref": "#/definitions/__schema9" } }, "additionalProperties": { "$ref": "#/definitions/__schema11" }, "description": "SMS payload. `text` is the body; media IDs must already exist in the account." } }, "required": [ "fromNumber", "toNumber", "smsMessage" ], "additionalProperties": {} } }, "required": [ "body" ], "definitions": { "__schema0": { "type": "string", "description": "SMS body. Required on send; an empty value returns HTTP 400. Personalization tokens are resolved at send time." }, "__schema1": { "type": "boolean", "description": "When true, append the STOP/HELP compliance footer to the body. Use GET /api/public/v1/message/compliance for the default text." }, "__schema2": { "type": "boolean", "description": "When true, resolve personalization tokens, then replace each URL in the body with a tracked short link on the account's primary short domain (or a default CallLoop domain). Default false. The link is stamped with this message's id at send time." }, "__schema3": { "type": "boolean", "description": "When true, skip sending to contacts on the DNC list. Default false." }, "__schema4": { "type": "string", "description": "Extra text appended after the standard `Reply STOP to end.` prefix when `compliance` is true. Ignored when `compliance` is false." }, "__schema5": { "type": "array", "items": { "$ref": "#/definitions/__schema6" }, "description": "IDs of existing MMS/assets in the account. Upload assets in CallLoop first; send does not accept files." }, "__schema6": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema7": { "type": "array", "items": { "$ref": "#/definitions/__schema8" }, "description": "IDs of existing contact cards in the account. Not created on send." }, "__schema8": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema9": { "type": "array", "items": { "$ref": "#/definitions/__schema10" }, "description": "IDs of existing audio items in the account. Upload audio in CallLoop first; send does not accept files." }, "__schema10": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "__schema11": {} } } }, "send_a_voice_message": { "name": "send_a_voice_message", "description": "Send a voice message", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "fromNumber": { "type": "string", "minLength": 1, "description": "Caller ID / from number on your CallLoop account. Prefer E.164 (`+15551234567`). Invalid format returns HTTP 400 (`From number is invalid`)." }, "toNumber": { "type": "string", "minLength": 1, "description": "Destination number. Prefer E.164 (`+15551234567`). Matched or created as a contact. Invalid format returns HTTP 400 (`To number is invalid`)." }, "voiceMessage": { "type": "object", "properties": { "liveAnswer": { "$ref": "#/definitions/__schema0" }, "voiceMail": { "$ref": "#/definitions/__schema1" }, "validOnly": { "$ref": "#/definitions/__schema2" }, "premiumAmDetectionEnabled": { "$ref": "#/definitions/__schema3" } }, "additionalProperties": { "$ref": "#/definitions/__schema4" }, "description": "Voice payload. At least one enabled audio ID is required (`liveAnswer` and/or `voiceMail`)." } }, "required": [ "fromNumber", "toNumber", "voiceMessage" ], "additionalProperties": {} } }, "required": [ "body" ], "definitions": { "__schema0": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "transferCallEnabled": { "type": "boolean" }, "transferCallDigit": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "transferCallNumber": { "type": "string" }, "unsubscribeDigit": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "audioId": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "ID of an existing audio item played on live answer. Upload audio in CallLoop first; send does not accept files." } }, "additionalProperties": {} }, "__schema1": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "audioId": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "ID of an existing audio item left as voicemail. Upload audio in CallLoop first; send does not accept files." } }, "additionalProperties": {} }, "__schema2": { "type": "boolean", "description": "When true, skip sending if the destination contact is on the DNC list (`state.status` = `Skipped`). Default false." }, "__schema3": { "type": "boolean", "description": "When true, use premium answering-machine detection (more accurate AMD; may incur extra cost). Default false." }, "__schema4": {} } } } }, "resources": [], "prompts": [] } }