Create carrier
API Refs
- Staging: Create carrier
This endpoint creates a new carrier in your agency's account. Each carrier must have contact information, business details, and a physical address.
Request body
Name | Type | Description | Required |
---|---|---|---|
firstName | string | First name of the carrier contact (max 255 characters) | yes |
lastName | string | Last name of the carrier contact (max 255 characters) | yes |
businessName | string | Business name of the carrier (max 255 characters) | yes |
string | Primary contact email address | yes | |
commission | number | Commission percentage (e.g., 15.0 for 15%) | yes |
address | object | Physical address information | yes |
Address object
Name | Type | Description | Required |
---|---|---|---|
address1 | string | Primary address line | yes |
address2 | string | Secondary address line | no |
city | string | City name | yes |
state | string | Two-letter US state code | yes |
postalCode | string | 5-digit postal code | yes |
phone | string | Contact phone number | yes |
alias | string | Reference name for this address | yes |
Response
Name | Type | Description |
---|---|---|
id | number | Unique carrier identifier |
name | string | Carrier business name |
string | Primary contact email | |
commission | number | Commission percentage |
Example
{
"firstName": "John",
"lastName": "Smith",
"businessName": "ABC Insurance Co",
"email": "[email protected]",
"commission": 15.0,
"address": {
"address1": "123 Main St",
"address2": "Suite 100",
"city": "Chicago",
"state": "IL",
"postalCode": "60601",
"phone": "312-555-0123",
"alias": "main-office"
}
}
NoteThe commission rate cannot be modified through the API after creation. Any changes to commission rates must be made through the AgentSnap dashboard.
Important: The business name must be unique within your agency's account.
Updated 1 day ago