Address Errors
The following error codes and messages appear in REST responses when an error prevents completion of the request.
Error Code | Description |
|---|---|
ERROR_ADDRESS_GET | The request attempted an operation that requires an address, but the address was not found. The request was rejected. Corrective action: For the 'address' parameter, use a valid address ID. |
ERROR_DELETE_ADDRESS | The request tried to delete the address, but this operation failed. The request was rejected. Corrective action: None. Only an address that is linked to a customer or not linked to any object can be deleted. |
INVALID_ADDRESS_ID | The request tried to update an address, but the address was not found. The request was rejected. Corrective action: Create a new address. |
INVALID_ADDRESS_LINE_1 | The request attempted an operation that requires an address, but Line 1 of the address was missing. The request was rejected. Corrective action: In the 'line_1' field, provide a valid street address. |
INVALID_ADDRESS_NAME | The request attempted an operation that requires an address, but the name associated with the address was missing. The request was rejected. Corrective action: In the 'name' field, provide a valid personal or business name. |
INVALID_ADDRESS_PHONE_NUMBER | The request tried to add or update a phone number for an address, but the phone number is not in proper E.164 format or is not valid. The request was rejected. Corrective action: Submit the phone number in proper E.164 format. |
INVALID_ADDRESS_ZIP | The request tried to create or update an address, but the postal code was not valid. The request was rejected. Corrective action: In the 'zip' field, use the correct postal code. |
INVALID_ADDRESSES_FORMAT | The request attempted an operation that requires an array of addresses, but the request provided a single address object. The request was rejected. Corrective action: For 'addresses', use an array of address objects. |
INVALID_CITY | The request tried to create or update an address, but the city contained special characters. The request was rejected. Corrective action: Submit the name of the city without special characters. |
INVALID_STATE | The request tried to add a state or province to an address, but the name contained special characters. The request was rejected. Corrective action: Use the correct spelling of the name. |