{ "service": "kustomer", "displayName": "Kustomer", "categories": [ "Productivity", "Data" ], "authTypes": [ "api_key" ], "auth": [ { "type": "api_key", "label": "API Key", "placeholder": "KUSTOMER_API_KEY", "description": "Kustomer API key sent as a Bearer token. Use a Kustomer API token with permissions for the customer endpoints; see the API introduction: https://help.kustomer.com/api-introduction-BkwVN42zM.", "extraFields": [] } ], "homepageUrl": "https://www.kustomer.com", "actions": [ { "id": "kustomer.create_customer", "service": "kustomer", "name": "create_customer", "description": "Create a Kustomer customer with common identity, contact, tag, and custom attribute fields.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "customer": { "type": "object", "properties": { "name": { "anyOf": [ { "type": "string", "minLength": 1, "description": "Customer display name." }, { "type": "null" } ] }, "company": { "anyOf": [ { "type": "string", "minLength": 1, "description": "Kustomer company ID to link to this customer." }, { "type": "null" } ] }, "externalId": { "anyOf": [ { "type": "string", "minLength": 1, "description": "Primary external customer ID." }, { "type": "null" } ] }, "username": { "anyOf": [ { "type": "string", "minLength": 1, "description": "Customer username." }, { "type": "null" } ] }, "signedUpAt": { "anyOf": [ { "type": "string", "description": "Timestamp when the customer signed up.", "format": "date-time" }, { "type": "null" } ] }, "lastActivityAt": { "anyOf": [ { "type": "string", "description": "Timestamp of the customer's last activity.", "format": "date-time" }, { "type": "null" } ] }, "lastCustomerActivityAt": { "anyOf": [ { "type": "string", "description": "Timestamp of the customer's last tracked customer activity.", "format": "date-time" }, { "type": "null" } ] }, "lastSeenAt": { "anyOf": [ { "type": "string", "description": "Timestamp when the customer was last seen.", "format": "date-time" }, { "type": "null" } ] }, "avatarUrl": { "anyOf": [ { "type": "string", "description": "Customer avatar URL.", "format": "uri" }, { "type": "null" } ] }, "externalIds": { "type": "array", "items": { "type": "object", "properties": { "externalId": { "type": "string", "minLength": 1, "description": "External customer ID from another system." }, "verified": { "type": "boolean", "description": "Whether this external ID is verified." } }, "additionalProperties": false, "required": [ "externalId" ], "description": "A Kustomer external ID object." }, "description": "External IDs to attach to this customer.", "maxItems": 10 }, "sharedExternalIds": { "type": "array", "items": { "type": "object", "properties": { "externalId": { "type": "string", "minLength": 1, "description": "External customer ID from another system." }, "verified": { "type": "boolean", "description": "Whether this external ID is verified." } }, "additionalProperties": false, "required": [ "externalId" ], "description": "A Kustomer external ID object." }, "description": "Shared external IDs to attach to this customer.", "maxItems": 10 }, "emails": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "description": "Customer email address.", "format": "email" }, "type": { "type": "string", "enum": [ "home", "work", "other" ], "description": "The email label." }, "verified": { "type": "boolean", "description": "Whether this email address is verified." } }, "additionalProperties": false, "required": [ "email" ], "description": "A Kustomer customer email contact object." }, "description": "Email addresses to attach to this customer.", "maxItems": 10 }, "sharedEmails": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "description": "Customer email address.", "format": "email" }, "type": { "type": "string", "enum": [ "home", "work", "other" ], "description": "The email label." }, "verified": { "type": "boolean", "description": "Whether this email address is verified." } }, "additionalProperties": false, "required": [ "email" ], "description": "A Kustomer customer email contact object." }, "description": "Shared email addresses to attach to this customer.", "maxItems": 10 }, "phones": { "type": "array", "items": { "type": "object", "properties": { "phone": { "type": "string", "minLength": 1, "description": "Customer phone number." }, "type": { "type": "string", "enum": [ "mobile", "home", "work", "fax", "other" ], "description": "The phone label." }, "verified": { "type": "boolean", "description": "Whether this phone number is verified." } }, "additionalProperties": false, "required": [ "phone" ], "description": "A Kustomer customer phone contact object." }, "description": "Phone numbers to attach to this customer.", "maxItems": 10 }, "sharedPhones": { "type": "array", "items": { "type": "object", "properties": { "phone": { "type": "string", "minLength": 1, "description": "Customer phone number." }, "type": { "type": "string", "enum": [ "mobile", "home", "work", "fax", "other" ], "description": "The phone label." }, "verified": { "type": "boolean", "description": "Whether this phone number is verified." } }, "additionalProperties": false, "required": [ "phone" ], "description": "A Kustomer customer phone contact object." }, "description": "Shared phone numbers to attach to this customer.", "maxItems": 10 }, "whatsapps": { "type": "array", "items": { "type": "object", "properties": { "phone": { "type": "string", "minLength": 1, "description": "Customer WhatsApp phone number." }, "type": { "type": "string", "enum": [ "mobile" ], "description": "The WhatsApp label." }, "verified": { "type": "boolean", "description": "Whether this WhatsApp number is verified." } }, "additionalProperties": false, "required": [ "phone" ], "description": "A Kustomer customer WhatsApp contact object." }, "description": "WhatsApp numbers to attach to this customer.", "maxItems": 10 }, "facebookIds": { "type": "array", "items": { "type": "object", "properties": { "pageId": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Facebook page ID." }, "userId": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Facebook user ID." }, "name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Facebook user display name." } }, "additionalProperties": false, "required": [ "pageId", "userId" ], "description": "A Kustomer customer Facebook identity object." }, "description": "Facebook identities to attach to this customer.", "maxItems": 10 }, "instagramIds": { "type": "array", "items": { "type": "object", "properties": { "pageId": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Instagram page ID." }, "threadId": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Instagram thread ID." }, "username": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Instagram username." }, "instagramId": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Instagram user ID." } }, "additionalProperties": false, "required": [ "pageId", "threadId", "username" ], "description": "A Kustomer customer Instagram identity object." }, "description": "Instagram identities to attach to this customer.", "maxItems": 10 }, "socials": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "twitter", "facebook", "instagram", "linkedin", "pinterest" ], "description": "The social network type." }, "username": { "type": "string", "minLength": 1, "description": "Customer social username." }, "userid": { "type": "string", "minLength": 1, "description": "Customer social user ID." }, "url": { "type": "string", "description": "Customer social profile URL.", "format": "uri" }, "verified": { "type": "boolean", "description": "Whether this social identity is verified." } }, "additionalProperties": false, "required": [ "type", "username" ], "description": "A Kustomer customer social identity object." }, "description": "Social identities to attach to this customer.", "maxItems": 10 }, "sharedSocials": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "twitter", "facebook", "instagram", "linkedin", "pinterest" ], "description": "The social network type." }, "username": { "type": "string", "minLength": 1, "description": "Customer social username." }, "userid": { "type": "string", "minLength": 1, "description": "Customer social user ID." }, "url": { "type": "string", "description": "Customer social profile URL.", "format": "uri" }, "verified": { "type": "boolean", "description": "Whether this social identity is verified." } }, "additionalProperties": false, "required": [ "type", "username" ], "description": "A Kustomer customer social identity object." }, "description": "Shared social identities to attach to this customer.", "maxItems": 10 }, "urls": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "Customer URL.", "format": "uri" }, "type": { "type": "string", "enum": [ "website", "blog", "other" ], "description": "The URL label." } }, "additionalProperties": false, "required": [ "url" ], "description": "A Kustomer customer URL object." }, "description": "URLs to attach to this customer.", "maxItems": 10 }, "locations": { "type": "array", "items": { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "home", "work", "other" ], "description": "The location label." }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string", "description": "Location display name." }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string", "maxLength": 256, "description": "Location street address." }, { "type": "null" } ] }, "address2": { "anyOf": [ { "type": "string", "maxLength": 256, "description": "Additional location street address." }, { "type": "null" } ] }, "address3": { "anyOf": [ { "type": "string", "maxLength": 256, "description": "Additional location street address." }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number", "description": "Location latitude." }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number", "description": "Location longitude." }, { "type": "null" } ] }, "countryCode": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 2, "description": "Two-letter country code." }, { "type": "null" } ] }, "countryName": { "anyOf": [ { "type": "string", "maxLength": 64, "description": "Country name." }, { "type": "null" } ] }, "regionCode": { "anyOf": [ { "type": "string", "maxLength": 2, "description": "Region code." }, { "type": "null" } ] }, "regionName": { "anyOf": [ { "type": "string", "maxLength": 128, "description": "Region name." }, { "type": "null" } ] }, "cityName": { "anyOf": [ { "type": "string", "maxLength": 128, "description": "City name." }, { "type": "null" } ] }, "zipCode": { "anyOf": [ { "type": "string", "maxLength": 30, "description": "Postal code." }, { "type": "null" } ] }, "areaCode": { "anyOf": [ { "type": "string", "maxLength": 30, "description": "Area code." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "A Kustomer customer location object." }, "description": "Locations to attach to this customer.", "maxItems": 10 }, "locale": { "anyOf": [ { "type": "string", "minLength": 1, "description": "Customer locale, such as en_US." }, { "type": "null" } ] }, "timeZone": { "anyOf": [ { "type": "string", "minLength": 1, "description": "Customer time zone, such as America/New_York." }, { "type": "null" } ] }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1, "description": "Tag ID or name." }, "description": "Kustomer tag IDs or names to attach to this customer.", "maxItems": 20 }, "sentiment": { "type": "object", "properties": { "polarity": { "anyOf": [ { "const": -1, "type": "number", "description": "Negative sentiment." }, { "const": 0, "type": "number", "description": "Neutral sentiment." }, { "const": 1, "type": "number", "description": "Positive sentiment." } ], "description": "Sentiment polarity." }, "confidence": { "type": "number", "minimum": -1, "maximum": 1, "description": "Sentiment confidence score between -1 and 1." } }, "additionalProperties": false, "description": "Kustomer customer sentiment score." }, "custom": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Kustomer custom attributes keyed by custom attribute name." }, "birthdayAt": { "anyOf": [ { "type": "string", "description": "Customer birthday timestamp.", "format": "date-time" }, { "type": "null" } ] }, "gender": { "anyOf": [ { "type": "string", "enum": [ "m", "f" ], "description": "Customer gender." }, { "type": "null" } ] }, "createdAt": { "type": "string", "description": "Timestamp when the customer was created.", "format": "date-time" }, "importedAt": { "type": "string", "description": "Timestamp when the customer was imported.", "format": "date-time" }, "rev": { "type": "number", "description": "Kustomer customer revision number." }, "defaultLang": { "anyOf": [ { "type": "string", "minLength": 1, "description": "Customer default language code." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "Kustomer customer attributes accepted by create and update customer endpoints." } }, "additionalProperties": false, "description": "Parameters for creating a Kustomer customer." }, "outputSchema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw Kustomer JSON:API customer resource object, including type, id, attributes, relationships, and links when returned." }, { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw Kustomer JSON:API customer resource object, including type, id, attributes, relationships, and links when returned." }, "description": "The Kustomer customer resources returned by a multi-ID lookup." } ], "description": "The Kustomer customer resource or resources returned by the endpoint." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Kustomer response metadata such as pagination totals." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Kustomer JSON:API links returned with the response." }, "included": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw Kustomer JSON:API included resource object, such as an included company." }, "description": "Kustomer JSON:API included resources returned when include parameters are used." } }, "additionalProperties": false, "required": [ "data" ], "description": "A Kustomer response containing one customer resource." } }, { "id": "kustomer.get_customer", "service": "kustomer", "name": "get_customer", "description": "Retrieve one Kustomer customer by customer ID.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "Kustomer customer ID. A comma-separated list can retrieve multiple customers." }, "include": { "type": "string", "minLength": 1, "description": "Comma-separated includes. Kustomer documents company as the supported include for customer lookup endpoints." } }, "additionalProperties": false, "required": [ "id" ], "description": "Parameters for retrieving a Kustomer customer by ID." }, "outputSchema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw Kustomer JSON:API customer resource object, including type, id, attributes, relationships, and links when returned." }, { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw Kustomer JSON:API customer resource object, including type, id, attributes, relationships, and links when returned." }, "description": "The Kustomer customer resources returned by a multi-ID lookup." } ], "description": "The Kustomer customer resource or resources returned by the endpoint." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Kustomer response metadata such as pagination totals." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Kustomer JSON:API links returned with the response." }, "included": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw Kustomer JSON:API included resource object, such as an included company." }, "description": "Kustomer JSON:API included resources returned when include parameters are used." } }, "additionalProperties": false, "required": [ "data" ], "description": "A Kustomer response containing one customer resource." } }, { "id": "kustomer.get_customer_by_email", "service": "kustomer", "name": "get_customer_by_email", "description": "Retrieve one Kustomer customer by email address.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "email": { "type": "string", "minLength": 1, "description": "Customer email address." }, "include": { "type": "string", "minLength": 1, "description": "Comma-separated includes. Kustomer documents company as the supported include for customer lookup endpoints." } }, "additionalProperties": false, "required": [ "email" ], "description": "Parameters for retrieving a Kustomer customer by email address." }, "outputSchema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw Kustomer JSON:API customer resource object, including type, id, attributes, relationships, and links when returned." }, { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw Kustomer JSON:API customer resource object, including type, id, attributes, relationships, and links when returned." }, "description": "The Kustomer customer resources returned by a multi-ID lookup." } ], "description": "The Kustomer customer resource or resources returned by the endpoint." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Kustomer response metadata such as pagination totals." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Kustomer JSON:API links returned with the response." }, "included": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw Kustomer JSON:API included resource object, such as an included company." }, "description": "Kustomer JSON:API included resources returned when include parameters are used." } }, "additionalProperties": false, "required": [ "data" ], "description": "A Kustomer response containing one customer resource." } }, { "id": "kustomer.get_customer_by_external_id", "service": "kustomer", "name": "get_customer_by_external_id", "description": "Retrieve one Kustomer customer by external ID.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "externalId": { "type": "string", "minLength": 1, "description": "External customer ID from another system." }, "include": { "type": "string", "minLength": 1, "description": "Comma-separated includes. Kustomer documents company as the supported include for customer lookup endpoints." } }, "additionalProperties": false, "required": [ "externalId" ], "description": "Parameters for retrieving a Kustomer customer by external ID." }, "outputSchema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw Kustomer JSON:API customer resource object, including type, id, attributes, relationships, and links when returned." }, { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw Kustomer JSON:API customer resource object, including type, id, attributes, relationships, and links when returned." }, "description": "The Kustomer customer resources returned by a multi-ID lookup." } ], "description": "The Kustomer customer resource or resources returned by the endpoint." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Kustomer response metadata such as pagination totals." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Kustomer JSON:API links returned with the response." }, "included": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw Kustomer JSON:API included resource object, such as an included company." }, "description": "Kustomer JSON:API included resources returned when include parameters are used." } }, "additionalProperties": false, "required": [ "data" ], "description": "A Kustomer response containing one customer resource." } }, { "id": "kustomer.get_customer_by_phone", "service": "kustomer", "name": "get_customer_by_phone", "description": "Retrieve one Kustomer customer by phone number.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "phone": { "type": "string", "minLength": 1, "description": "Customer phone number." }, "include": { "type": "string", "minLength": 1, "description": "Comma-separated includes. Kustomer documents company as the supported include for customer lookup endpoints." } }, "additionalProperties": false, "required": [ "phone" ], "description": "Parameters for retrieving a Kustomer customer by phone number." }, "outputSchema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw Kustomer JSON:API customer resource object, including type, id, attributes, relationships, and links when returned." }, { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw Kustomer JSON:API customer resource object, including type, id, attributes, relationships, and links when returned." }, "description": "The Kustomer customer resources returned by a multi-ID lookup." } ], "description": "The Kustomer customer resource or resources returned by the endpoint." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Kustomer response metadata such as pagination totals." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Kustomer JSON:API links returned with the response." }, "included": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw Kustomer JSON:API included resource object, such as an included company." }, "description": "Kustomer JSON:API included resources returned when include parameters are used." } }, "additionalProperties": false, "required": [ "data" ], "description": "A Kustomer response containing one customer resource." } }, { "id": "kustomer.list_customers", "service": "kustomer", "name": "list_customers", "description": "List Kustomer customers with pagination, sorting, and createdAt or updatedAt timestamp filters.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "filter": { "type": "object", "properties": { "createdAt": { "type": "object", "properties": { "gt": { "type": "string", "description": "Return customers with a timestamp greater than this ISO 8601 value.", "format": "date-time" }, "gte": { "type": "string", "description": "Return customers with a timestamp greater than or equal to this ISO 8601 value.", "format": "date-time" }, "lt": { "type": "string", "description": "Return customers with a timestamp less than this ISO 8601 value.", "format": "date-time" }, "lte": { "type": "string", "description": "Return customers with a timestamp less than or equal to this ISO 8601 value.", "format": "date-time" } }, "additionalProperties": false, "description": "Filter customers by creation timestamp." }, "updatedAt": { "type": "object", "properties": { "gt": { "type": "string", "description": "Return customers with a timestamp greater than this ISO 8601 value.", "format": "date-time" }, "gte": { "type": "string", "description": "Return customers with a timestamp greater than or equal to this ISO 8601 value.", "format": "date-time" }, "lt": { "type": "string", "description": "Return customers with a timestamp less than this ISO 8601 value.", "format": "date-time" }, "lte": { "type": "string", "description": "Return customers with a timestamp less than or equal to this ISO 8601 value.", "format": "date-time" } }, "additionalProperties": false, "description": "Filter customers by last update timestamp." } }, "additionalProperties": false, "description": "Kustomer customer list filters for createdAt and updatedAt timestamp ranges." }, "sort": { "type": "string", "enum": [ "createdAt", "-createdAt", "updatedAt", "-updatedAt" ], "description": "Sort customers by createdAt or updatedAt, with '-' for descending order." }, "page": { "type": "integer", "minimum": 1, "description": "Page number of customer results to return." }, "pageSize": { "type": "integer", "minimum": 1, "description": "Number of customer results to return per page." } }, "additionalProperties": false, "description": "Pagination, sorting, and timestamp filters for listing Kustomer customers." }, "outputSchema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw Kustomer JSON:API customer resource object, including type, id, attributes, relationships, and links when returned." }, "description": "The Kustomer customer resources returned on this page." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Kustomer response metadata such as pagination totals." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Kustomer JSON:API links returned with the response." }, "included": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw Kustomer JSON:API included resource object, such as an included company." }, "description": "Kustomer JSON:API included resources returned when include parameters are used." } }, "additionalProperties": false, "required": [ "data" ], "description": "A Kustomer response containing a page of customer resources." } }, { "id": "kustomer.search_customers", "service": "kustomer", "name": "search_customers", "description": "Search Kustomer customers with Kustomer's JSON search criteria DSL.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "query": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Kustomer customer search criteria JSON body." }, "page": { "type": "integer", "minimum": 1, "description": "Page number of search results to return." }, "pageSize": { "type": "integer", "minimum": 1, "description": "Number of search results to return per page." }, "idsOnly": { "type": "boolean", "description": "Return only matching customer IDs." }, "id": { "type": "string", "minLength": 1, "description": "Saved search ID used to execute a stored query before searching." }, "withIntelliAggs": { "type": "boolean", "description": "Include intelligent aggregation data in search results." }, "trackTotalHits": { "type": "boolean", "description": "Track an exact total hit count for the search request." } }, "additionalProperties": false, "required": [ "query" ], "description": "Parameters for searching Kustomer customers." }, "outputSchema": { "type": "object", "properties": { "data": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw Kustomer JSON:API customer resource object, including type, id, attributes, relationships, and links when returned." }, { "type": "string", "minLength": 1, "description": "Customer ID returned when idsOnly is true." } ], "description": "One Kustomer customer search result." }, "description": "The Kustomer customer resources returned on this page, or customer IDs when idsOnly is true." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Kustomer response metadata such as pagination totals." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Kustomer JSON:API links returned with the response." }, "included": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw Kustomer JSON:API included resource object, such as an included company." }, "description": "Kustomer JSON:API included resources returned when include parameters are used." } }, "additionalProperties": false, "required": [ "data" ], "description": "A Kustomer response containing customer search results." } }, { "id": "kustomer.update_customer", "service": "kustomer", "name": "update_customer", "description": "Update a Kustomer customer with common identity, contact, tag, and custom attribute fields.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "Kustomer customer ID." }, "replace": { "type": "boolean", "description": "If true, replace the full resource instead of applying merge semantics." }, "customer": { "type": "object", "properties": { "name": { "anyOf": [ { "type": "string", "minLength": 1, "description": "Customer display name." }, { "type": "null" } ] }, "company": { "anyOf": [ { "type": "string", "minLength": 1, "description": "Kustomer company ID to link to this customer." }, { "type": "null" } ] }, "externalId": { "anyOf": [ { "type": "string", "minLength": 1, "description": "Primary external customer ID." }, { "type": "null" } ] }, "username": { "anyOf": [ { "type": "string", "minLength": 1, "description": "Customer username." }, { "type": "null" } ] }, "signedUpAt": { "anyOf": [ { "type": "string", "description": "Timestamp when the customer signed up.", "format": "date-time" }, { "type": "null" } ] }, "lastActivityAt": { "anyOf": [ { "type": "string", "description": "Timestamp of the customer's last activity.", "format": "date-time" }, { "type": "null" } ] }, "lastCustomerActivityAt": { "anyOf": [ { "type": "string", "description": "Timestamp of the customer's last tracked customer activity.", "format": "date-time" }, { "type": "null" } ] }, "lastSeenAt": { "anyOf": [ { "type": "string", "description": "Timestamp when the customer was last seen.", "format": "date-time" }, { "type": "null" } ] }, "avatarUrl": { "anyOf": [ { "type": "string", "description": "Customer avatar URL.", "format": "uri" }, { "type": "null" } ] }, "externalIds": { "type": "array", "items": { "type": "object", "properties": { "externalId": { "type": "string", "minLength": 1, "description": "External customer ID from another system." }, "verified": { "type": "boolean", "description": "Whether this external ID is verified." } }, "additionalProperties": false, "required": [ "externalId" ], "description": "A Kustomer external ID object." }, "description": "External IDs to attach to this customer.", "maxItems": 10 }, "sharedExternalIds": { "type": "array", "items": { "type": "object", "properties": { "externalId": { "type": "string", "minLength": 1, "description": "External customer ID from another system." }, "verified": { "type": "boolean", "description": "Whether this external ID is verified." } }, "additionalProperties": false, "required": [ "externalId" ], "description": "A Kustomer external ID object." }, "description": "Shared external IDs to attach to this customer.", "maxItems": 10 }, "emails": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "description": "Customer email address.", "format": "email" }, "type": { "type": "string", "enum": [ "home", "work", "other" ], "description": "The email label." }, "verified": { "type": "boolean", "description": "Whether this email address is verified." } }, "additionalProperties": false, "required": [ "email" ], "description": "A Kustomer customer email contact object." }, "description": "Email addresses to attach to this customer.", "maxItems": 10 }, "sharedEmails": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "description": "Customer email address.", "format": "email" }, "type": { "type": "string", "enum": [ "home", "work", "other" ], "description": "The email label." }, "verified": { "type": "boolean", "description": "Whether this email address is verified." } }, "additionalProperties": false, "required": [ "email" ], "description": "A Kustomer customer email contact object." }, "description": "Shared email addresses to attach to this customer.", "maxItems": 10 }, "phones": { "type": "array", "items": { "type": "object", "properties": { "phone": { "type": "string", "minLength": 1, "description": "Customer phone number." }, "type": { "type": "string", "enum": [ "mobile", "home", "work", "fax", "other" ], "description": "The phone label." }, "verified": { "type": "boolean", "description": "Whether this phone number is verified." } }, "additionalProperties": false, "required": [ "phone" ], "description": "A Kustomer customer phone contact object." }, "description": "Phone numbers to attach to this customer.", "maxItems": 10 }, "sharedPhones": { "type": "array", "items": { "type": "object", "properties": { "phone": { "type": "string", "minLength": 1, "description": "Customer phone number." }, "type": { "type": "string", "enum": [ "mobile", "home", "work", "fax", "other" ], "description": "The phone label." }, "verified": { "type": "boolean", "description": "Whether this phone number is verified." } }, "additionalProperties": false, "required": [ "phone" ], "description": "A Kustomer customer phone contact object." }, "description": "Shared phone numbers to attach to this customer.", "maxItems": 10 }, "whatsapps": { "type": "array", "items": { "type": "object", "properties": { "phone": { "type": "string", "minLength": 1, "description": "Customer WhatsApp phone number." }, "type": { "type": "string", "enum": [ "mobile" ], "description": "The WhatsApp label." }, "verified": { "type": "boolean", "description": "Whether this WhatsApp number is verified." } }, "additionalProperties": false, "required": [ "phone" ], "description": "A Kustomer customer WhatsApp contact object." }, "description": "WhatsApp numbers to attach to this customer.", "maxItems": 10 }, "facebookIds": { "type": "array", "items": { "type": "object", "properties": { "pageId": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Facebook page ID." }, "userId": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Facebook user ID." }, "name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Facebook user display name." } }, "additionalProperties": false, "required": [ "pageId", "userId" ], "description": "A Kustomer customer Facebook identity object." }, "description": "Facebook identities to attach to this customer.", "maxItems": 10 }, "instagramIds": { "type": "array", "items": { "type": "object", "properties": { "pageId": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Instagram page ID." }, "threadId": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Instagram thread ID." }, "username": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Instagram username." }, "instagramId": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Instagram user ID." } }, "additionalProperties": false, "required": [ "pageId", "threadId", "username" ], "description": "A Kustomer customer Instagram identity object." }, "description": "Instagram identities to attach to this customer.", "maxItems": 10 }, "socials": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "twitter", "facebook", "instagram", "linkedin", "pinterest" ], "description": "The social network type." }, "username": { "type": "string", "minLength": 1, "description": "Customer social username." }, "userid": { "type": "string", "minLength": 1, "description": "Customer social user ID." }, "url": { "type": "string", "description": "Customer social profile URL.", "format": "uri" }, "verified": { "type": "boolean", "description": "Whether this social identity is verified." } }, "additionalProperties": false, "required": [ "type", "username" ], "description": "A Kustomer customer social identity object." }, "description": "Social identities to attach to this customer.", "maxItems": 10 }, "sharedSocials": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "twitter", "facebook", "instagram", "linkedin", "pinterest" ], "description": "The social network type." }, "username": { "type": "string", "minLength": 1, "description": "Customer social username." }, "userid": { "type": "string", "minLength": 1, "description": "Customer social user ID." }, "url": { "type": "string", "description": "Customer social profile URL.", "format": "uri" }, "verified": { "type": "boolean", "description": "Whether this social identity is verified." } }, "additionalProperties": false, "required": [ "type", "username" ], "description": "A Kustomer customer social identity object." }, "description": "Shared social identities to attach to this customer.", "maxItems": 10 }, "urls": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "Customer URL.", "format": "uri" }, "type": { "type": "string", "enum": [ "website", "blog", "other" ], "description": "The URL label." } }, "additionalProperties": false, "required": [ "url" ], "description": "A Kustomer customer URL object." }, "description": "URLs to attach to this customer.", "maxItems": 10 }, "locations": { "type": "array", "items": { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "home", "work", "other" ], "description": "The location label." }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string", "description": "Location display name." }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string", "maxLength": 256, "description": "Location street address." }, { "type": "null" } ] }, "address2": { "anyOf": [ { "type": "string", "maxLength": 256, "description": "Additional location street address." }, { "type": "null" } ] }, "address3": { "anyOf": [ { "type": "string", "maxLength": 256, "description": "Additional location street address." }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number", "description": "Location latitude." }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number", "description": "Location longitude." }, { "type": "null" } ] }, "countryCode": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 2, "description": "Two-letter country code." }, { "type": "null" } ] }, "countryName": { "anyOf": [ { "type": "string", "maxLength": 64, "description": "Country name." }, { "type": "null" } ] }, "regionCode": { "anyOf": [ { "type": "string", "maxLength": 2, "description": "Region code." }, { "type": "null" } ] }, "regionName": { "anyOf": [ { "type": "string", "maxLength": 128, "description": "Region name." }, { "type": "null" } ] }, "cityName": { "anyOf": [ { "type": "string", "maxLength": 128, "description": "City name." }, { "type": "null" } ] }, "zipCode": { "anyOf": [ { "type": "string", "maxLength": 30, "description": "Postal code." }, { "type": "null" } ] }, "areaCode": { "anyOf": [ { "type": "string", "maxLength": 30, "description": "Area code." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "A Kustomer customer location object." }, "description": "Locations to attach to this customer.", "maxItems": 10 }, "locale": { "anyOf": [ { "type": "string", "minLength": 1, "description": "Customer locale, such as en_US." }, { "type": "null" } ] }, "timeZone": { "anyOf": [ { "type": "string", "minLength": 1, "description": "Customer time zone, such as America/New_York." }, { "type": "null" } ] }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1, "description": "Tag ID or name." }, "description": "Kustomer tag IDs or names to attach to this customer.", "maxItems": 20 }, "sentiment": { "type": "object", "properties": { "polarity": { "anyOf": [ { "const": -1, "type": "number", "description": "Negative sentiment." }, { "const": 0, "type": "number", "description": "Neutral sentiment." }, { "const": 1, "type": "number", "description": "Positive sentiment." } ], "description": "Sentiment polarity." }, "confidence": { "type": "number", "minimum": -1, "maximum": 1, "description": "Sentiment confidence score between -1 and 1." } }, "additionalProperties": false, "description": "Kustomer customer sentiment score." }, "custom": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Kustomer custom attributes keyed by custom attribute name." }, "birthdayAt": { "anyOf": [ { "type": "string", "description": "Customer birthday timestamp.", "format": "date-time" }, { "type": "null" } ] }, "gender": { "anyOf": [ { "type": "string", "enum": [ "m", "f" ], "description": "Customer gender." }, { "type": "null" } ] }, "createdAt": { "type": "string", "description": "Timestamp when the customer was created.", "format": "date-time" }, "importedAt": { "type": "string", "description": "Timestamp when the customer was imported.", "format": "date-time" }, "rev": { "type": "number", "description": "Kustomer customer revision number." }, "defaultLang": { "anyOf": [ { "type": "string", "minLength": 1, "description": "Customer default language code." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "Kustomer customer attributes accepted by create and update customer endpoints." } }, "additionalProperties": false, "required": [ "id", "customer" ], "description": "Parameters for updating a Kustomer customer." }, "outputSchema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw Kustomer JSON:API customer resource object, including type, id, attributes, relationships, and links when returned." }, { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw Kustomer JSON:API customer resource object, including type, id, attributes, relationships, and links when returned." }, "description": "The Kustomer customer resources returned by a multi-ID lookup." } ], "description": "The Kustomer customer resource or resources returned by the endpoint." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Kustomer response metadata such as pagination totals." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Kustomer JSON:API links returned with the response." }, "included": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true, "description": "A raw Kustomer JSON:API included resource object, such as an included company." }, "description": "Kustomer JSON:API included resources returned when include parameters are used." } }, "additionalProperties": false, "required": [ "data" ], "description": "A Kustomer response containing one customer resource." } } ] }