Update carrier
This endpoint updates a carrier's information. All fields in the request body are optional - only include the fields you want to update.
URI Parameters
Name | Type | Description | Required |
---|---|---|---|
id | number | The carrier ID | yes |
Request body
Name | Type | Description | Required |
---|---|---|---|
firstName | string | First name of the carrier contact (max 255 characters) | no |
lastName | string | Last name of the carrier contact (max 255 characters) | no |
businessName | string | Business name of the carrier (max 255 characters) | no |
string | Primary contact email address | no | |
address | object | Physical address information | no |
Address object
Name | Type | Description | Required |
---|---|---|---|
address1 | string | Primary address line | no |
address2 | string | Secondary address line | no |
city | string | City name | no |
state | string | Two-letter US state code | no |
postalCode | string | 5-digit postal code | no |
phone | string | Contact phone number | no |
alias | string | Reference name for this address | no |
Example
{
"firstName": "Jane",
"lastName": "Smith",
"email": "[email protected]",
"address": {
"address1": "456 Market St",
"city": "Chicago",
"state": "IL",
"postalCode": "60602",
"phone": "312-555-0124",
"alias": "new-office"
}
}
NoteCommission rates cannot be modified through the API. Any changes to commission rates must be made through the AgentSnap dashboard.
ImportantIf updating the business name, the new name must still be unique within your agency's account.
Updated 1 day ago