Skip to main content

UpdateDispatchCustomerLocationModel

Customer location profile.

Breaking Changes​

No breaking changes.

Examples​

Fill this template out with real values.

{
"account_number_1": "String, optional",
"account_number_2": "String, optional",
"is_active": "Boolean, optional",
"is_commercial": "Boolean, optional",
"note": "String, optional",
"reference_number": "String, optional",
"renewal_date": "String, optional",
"sales_rep": "String, optional",
"sales_rep_id": "String, optional",
"suspension_id": "Integer, optional"
}

Fields​

account_number_1 String, Optional

Customer account number.

  • At least 0 and no more than 128 characters.

account_number_2 String, Optional

Customer account number.

  • At least 0 and no more than 128 characters.

is_active Boolean, Optional

Records marked inactive are treated as deleted (soft delete).

  • One of 0, 1, True, False (case insensitive).

is_commercial Boolean, Optional

Commercial address if true, private if false.

  • One of 0, 1, True, False (case insensitive).

note String, Optional

Notes (free text).

  • At least 0 and no more than 2048 characters.

reference_number String, Optional

Reference number (free text).

  • At least 1 and no more than 256 characters.

renewal_date String, Optional

Renewal date.

  • Date in an ISO 8601 compatible format.

sales_rep String, Optional

Name of sales representative.

  • At least 1 and no more than 64 characters.

sales_rep_id String, Optional

Sales rep identifier. May be an integer provider id, the sales user UUID, or the username.

  • At least 0 and no more than 64 characters.

suspension_id Integer, Optional

Suspension identifier.