createCustomer
Register new customers by providing name, email, and phone number. Add optional details like address, UTM parameters, and tags to create comprehensive customer profiles.
Instructions
Create a new customer in the external API. Requires name, email, and phone. Supports optional fields like address, UTM parameters, and more.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Customer full name (required) | |
| Yes | Customer email address (required) | ||
| phone | Yes | Customer phone number (required) | |
| retention | No | Retention flag | |
| identification | No | Customer identification document (e.g., CPF) | |
| zipcode | No | ZIP/Postal code | |
| state | No | State/Province | |
| street | No | Street name | |
| number | No | Street number | |
| neighborhood | No | Neighborhood | |
| city | No | City | |
| list_ids | No | List ID for categorization | |
| create_deal | No | Whether to create a deal | |
| tags | No | Tags for the customer | |
| url | No | URL reference | |
| utm_term | No | UTM term parameter | |
| utm_medium | No | UTM medium parameter | |
| utm_source | No | UTM source parameter | |
| utm_campaign | No | UTM campaign parameter | |
| company_id | No | Company ID | |
| utm_content | No | UTM content parameter |
Input Schema (JSON Schema)
{
"properties": {
"city": {
"description": "City",
"type": "string"
},
"company_id": {
"description": "Company ID",
"type": "string"
},
"create_deal": {
"description": "Whether to create a deal",
"type": "boolean"
},
"email": {
"description": "Customer email address (required)",
"type": "string"
},
"identification": {
"description": "Customer identification document (e.g., CPF)",
"type": "string"
},
"list_ids": {
"description": "List ID for categorization",
"type": "number"
},
"name": {
"description": "Customer full name (required)",
"type": "string"
},
"neighborhood": {
"description": "Neighborhood",
"type": "string"
},
"number": {
"description": "Street number",
"type": "string"
},
"phone": {
"description": "Customer phone number (required)",
"type": "string"
},
"retention": {
"description": "Retention flag",
"type": "boolean"
},
"state": {
"description": "State/Province",
"type": "string"
},
"street": {
"description": "Street name",
"type": "string"
},
"tags": {
"description": "Tags for the customer",
"type": "string"
},
"url": {
"description": "URL reference",
"type": "string"
},
"utm_campaign": {
"description": "UTM campaign parameter",
"type": "string"
},
"utm_content": {
"description": "UTM content parameter",
"type": "string"
},
"utm_medium": {
"description": "UTM medium parameter",
"type": "string"
},
"utm_source": {
"description": "UTM source parameter",
"type": "string"
},
"utm_term": {
"description": "UTM term parameter",
"type": "string"
},
"zipcode": {
"description": "ZIP/Postal code",
"type": "string"
}
},
"required": [
"name",
"email",
"phone"
],
"type": "object"
}