--- title: "Multiple account activation" method: POST path: "/v2/partition/{partitionId}/account/activation/multiple" tags: ["Account"] --- # Multiple account activation `POST /v2/partition/{partitionId}/account/activation/multiple` ## Request - Base URL: `https://api.alianza.com` - URL: `https://api.alianza.com/v2/partition/{partitionId}/account/activation/multiple` - Auth: API key in header `X-AUTH-TOKEN` - TypeScript: (a function with typed inputs; its response is checked against the schema) Use to activate multiple end users with telephone numbers in a single request. Supports up to 2 end users per request. ## Path parameters - `partitionId` string, required ## Request body - MultipleActivationX: Root object for activating multiple end users with telephone numbers in a single request - `account` Account, required - `id` string, required: Required to update an account, not required for new account - `partitionId` string, required: A partitionId identifies the business entity that this account is a part of. Refers to partition.id - `accountNumber` string, required: The accountNumber is a string that uniquely identifies the account within a partition. AccountNumbers can be used to search for an account. - `accountName` string, required: The account name is a string that describes the account. The accountName is a field that can be used to identify the account in a search, though it is not required to be unique. - `billingCycleDay` integer, required: The day that marks the start of a billing cycle. Must be between 1 and 28. - `customField` string: Can be used to store generic data for the account. - `status` 'ACTIVE' | 'DISABLED' | 'DELETED' | 'DELETE_PENDING' | 'SUSPENDED' | 'PENDING', required: The status of the account within Alianza's system. Must be one of [ACTIVE,DISABLED,DELETED,DELETE_PENDING,SUSPENDED,PENDING] - `timeZone` 'US/Samoa' | 'US/Hawaii' | 'US/Alaska' | 'US/Pacific' | 'US/Arizona' | 'US/Mountain' | 'US/Central' | 'US/Eastern' | 'America/St_Thomas' | 'Canada/Pacific' | 'Canada/Mountain' | 'Canada/Central' | 'Canada/Eastern' | 'Canada/Atlantic' | 'Canada/Newfoundland', required: The IANA Time Zone Database (TZDB) zone id for the account. Must be a timezone for an area within Alianza's supported regions. - `languageTag` string - `deletionDate` string, date-time: ISO 8601 formatted date string of when the account was deleted. This is a deprecated field as deleted accounts are no longer retained. This field is present for backwards compatibility with old data. - `accountType` 'SIMPLE' | 'ADVANCED', required: The account type indicates whether the account supports only a single user (SIMPLE) or multiple users (ADVANCED). - `platformType` 'V2_0' | 'V2_1' | 'CPE1' | 'CPE2': The platform type indicates the features that are supported for the account. CPE1 supports the basic telephone features while CPE2 supports the business cloud communication features. PlatformTypes of V1_0 and V2_0 are deprecated and only present for backwards compatibility. - `platformChangeDate` string, date-time - `inboundRatePlanProductId` string: Identifies the inbound rate plan product for the account. This plan controls how toll free numbers are handled in the account. This field is only required for accounts with toll-free numbers. - `extensionLength` integer, required: Length of extension, not required for accounts with a SIMPLE accountType. - `dialingBehaviorType` 'SEVEN_DIGIT' | 'TEN_DIGIT' | 'OPEN_DIAL_PLAN' | 'DIAL_NINE_SEVEN_DIGIT' | 'DIAL_NINE_TEN_DIGIT' | 'OPEN_DIAL_PLAN_TEN_DIGIT', required: Defines how a user would be required to dial in order to place a call. For example, being required to dial 9 before placing a call. - `routePlanId` string, uuid: UUID of the route plan for this account. Route plans determine where outbound calls are routed and are created for a partition by Alianza. The routePlanId must be one that is available on the account's partition. All users on an account will share the same outbound route plan. - `callScreeningSettings` CallScreeningSettingsX - `anonymousCallScreen` 'Allow' | 'Block' | 'Voicemail' | 'Forward' | 'VipRing' | 'BlockWithPrompt' - `anonymousRingType` 'StandardRing' | 'Ring1' | 'Ring2' | 'Ring3' | 'Ring4' | 'Ring5' | 'Ring6' | 'Ring7' - `tollFreeCallScreen` 'Allow' | 'Block' | 'Voicemail' | 'Forward' | 'VipRing' | 'BlockWithPrompt' - `tollFreeRingType` 'StandardRing' | 'Ring1' | 'Ring2' | 'Ring3' | 'Ring4' | 'Ring5' | 'Ring6' | 'Ring7' - `defaultCallScreen` 'Allow' | 'Block' | 'Voicemail' | 'Forward' | 'VipRing' | 'BlockWithPrompt' - `defaultRingType` 'StandardRing' | 'Ring1' | 'Ring2' | 'Ring3' | 'Ring4' | 'Ring5' | 'Ring6' | 'Ring7' - `customCallScreenList` CustomCallScreenX[] - `telephoneNumber` string - `blockType` 'Allow' | 'Block' | 'Voicemail' | 'Forward' | 'VipRing' | 'BlockWithPrompt' - `ringType` 'StandardRing' | 'Ring1' | 'Ring2' | 'Ring3' | 'Ring4' | 'Ring5' | 'Ring6' | 'Ring7' - `forwardTn` string - `holdMusicMediaId` string: Id of the music file to be played when an inbound call is placed on hold. - `holdTimeoutSeconds` integer: Time in seconds before a call that has been placed on hold will be terminated. Does not apply to CPE1 platformTypes. - `allowDangerousExtensions` boolean: Allows extensions starting with 1 - `domain` string: Overrides the partition default branding which is used in the display of end user emails and the end user portal. - `sendWelcomeEmail` boolean: Specifies if new users added to the account will receive a welcome email. - `regulatoryType` 'RESIDENTIAL' | 'COMMERCIAL' | 'GOVERNMENT', required - `endUserCount` integer: Indicates the number of end users associated with this account. - `customHoldMusicMediaId` string - `callingPlans` CallingPlanX[] - `id` string - `referenceId` string - `referenceType` 'SIP_TRUNK' | 'END_USER' | 'IVR' | 'ACCOUNT' | 'SPECIALTY_LINE' | 'CONTACT_CENTER' - `callingPlanProductId` string - `endDate` string, date-time - `startDate` string, date-time - `planMinutes` integer - `secondsRemaining` integer - `endUsers` EndUserWithMultipleTnActivationX[]: List of end users with telephone number activations (max 2) - `user` EndUserV2X, required - `id` string - `username` string: If the userProductPlan is ADVANCED or PROFESSIONAL, do not use an email as a username as this will result in loss of access to the softphone client. - `firstName` string - `lastName` string - `emailAddress` string: Must be a valid email address - `mustChangePassword` boolean - `languageTag` string: RFC-5646 Language tag. Refer to supported languages for a list of supported values. - `partitionId` string - `accountId` string - `callingPlans` CallingPlanX[]: callingPlans - `id` string - `referenceId` string - `referenceType` 'SIP_TRUNK' | 'END_USER' | 'IVR' | 'ACCOUNT' | 'SPECIALTY_LINE' | 'CONTACT_CENTER' - `callingPlanProductId` string - `endDate` string, date-time - `startDate` string, date-time - `planMinutes` integer - `secondsRemaining` integer - `devices` DeviceX[]: devices - `id` string, required: Not required for creating a new device line - `deviceTypeId` string, required: Identifies the equipment as well as the features that the device supports. Refers to deviceType.id. See also: Get All Device Types and Get Device Type by ID - `accountId` string, required: Not required for creating a new device line - `partitionId` string, required: Not required for creating a new device line - `macAddress` string: The 48-bit hexadecimal address assigned to the device by the manufacturer. Required if the device line refers to a physical device. Must not be claimed in another device request. - `deviceName` string, required - `emergencyNumber` string: Required if emergencyNumberReservationId is absent - `emergencyNumberReservationId` string: Required if emergencyNumber is absent - `faxEnabled` boolean, required - `lineNumber` integer, required: Required for POST & PUT operations only - `userId` string, required - `sipPassword` string - `sipUsername` string: Required to be globally unique if specified - `zipcode` string - `state` string - `lineType` 'Line' | 'AdvancedSharedLine' | 'ReferencedUser' | 'IntercomLine' | 'PresenceBlfUser' | 'SpeedDialUser' | 'SpeedDialTn' | 'CallParkingSpot' | 'SipPaging' | 'Custom' - `referenceId` string: Changes Depending on LineType. If LineType.Line then this should be null. If LineType.ReferencedUser, PresenceBlfUser, or SpeedDialUser then this should be a valid userid. If LineType.SpeedDialTn then this should be a valid phone number. - `provisioningRequest` ProvisioningRequestX - `id` string: The 48-bit hexadecimal address assigned to the device by the manufacturer. - `requestDate` string, date-time: The ISO 8601 formatted date string indicating when the device last tried to retrieve provisioning data. - `httpStatus` integer: The http status of the device's most recent request for provisioning. - `deviceId` string: DeviceId, reference to device.id - `ipAddress` string - `userAgent` string: The user agent that was used to retrieve the provisioning data. - `timeZone` 'US/Samoa' | 'US/Hawaii' | 'US/Alaska' | 'US/Pacific' | 'US/Arizona' | 'US/Mountain' | 'US/Central' | 'US/Eastern' | 'America/St_Thomas' | 'Canada/Pacific' | 'Canada/Mountain' | 'Canada/Central' | 'Canada/Eastern' | 'Canada/Atlantic' | 'Canada/Newfoundland', required - `extension` string - `callerIdConfig` CallerIdConfigX - `callerIdNumber` string - `externalCallerIdVisible` boolean, required - `extensionCallerIdVisible` boolean, required - `callerIdNumberReservationId` string - `callerIdName` string - `callHandlingSettings` CallHandlingSettingsX - `callWaitingEnabled` boolean - `doNotDisturbEnabled` boolean - `callHandlingOptionType` 'RingPhone' | 'ForwardAlways' | 'SimultaneousRing' | 'FindMeFollowMe' - `forwardAlwaysToNumber` string - `forwardAlwaysToNumberDescription` string - `ringPhoneCallHandling` RingPhoneCallHandlingX - `busyCallHandling` CallHandlingX - `type` 'Forward' | 'Voicemail' | 'Busy' - `forwardToNumber` string - `description` string - `noAnswerCallHandling` CallHandlingWithTimeoutX - `type` 'Forward' | 'Voicemail' | 'Busy' | 'RingForever' - `timeout` integer - `forwardToNumber` string - `description` string - `unregisteredCallHandling` CallHandlingX - `type` 'Forward' | 'Voicemail' | 'Busy' - `forwardToNumber` string - `description` string - `simultaneousRingCallHandling` SimultaneousRingCallHandlingX - `forwardToNumberList` string[] - `forwardToTimedNumberList` SimultaneousRingEndpointX[]: Mutually exclusive with forwardToNumberList; if both are sent, this list takes precedence when non-empty. Endpoint delays must be in chronological order with no gaps between active windows. The first endpoint delay must be less than or equal to noAnswerCallHandling.timeout. - `toNumber` string - `ringDelay` integer - `ringDuration` integer: When noAnswerCallHandling.type is RingForever, this value is ignored by the service. - `continueOnBusy` boolean - `noAnswerCallHandling` CallHandlingWithTimeoutX - `type` 'Forward' | 'Voicemail' | 'Busy' | 'RingForever' - `timeout` integer - `forwardToNumber` string - `description` string - `continueOnBusy` boolean - `findMeFollowMeCallHandling` FindMeFollowMeCallHandlingX - `findMeEndpoints` FindMeEndpointX[] - `ringUserDevice` boolean - `toNumber` string - `description` string - `timeout` integer - `toUserId` string - `continueOnBusy` boolean: Must be false for the last Find Me endpoint. - `busyCallHandling` CallHandlingX - `type` 'Forward' | 'Voicemail' | 'Busy' - `forwardToNumber` string - `description` string - `timeoutType` 'Forward' | 'Voicemail' | 'Busy' | 'RingForever' - `forwardAlwaysToNumberType` 'Extension' | 'PhoneNumber' | 'ShortCode' - `callScreeningSettings` CallScreeningSettingsX - `anonymousCallScreen` 'Allow' | 'Block' | 'Voicemail' | 'Forward' | 'VipRing' | 'BlockWithPrompt' - `anonymousRingType` 'StandardRing' | 'Ring1' | 'Ring2' | 'Ring3' | 'Ring4' | 'Ring5' | 'Ring6' | 'Ring7' - `tollFreeCallScreen` 'Allow' | 'Block' | 'Voicemail' | 'Forward' | 'VipRing' | 'BlockWithPrompt' - `tollFreeRingType` 'StandardRing' | 'Ring1' | 'Ring2' | 'Ring3' | 'Ring4' | 'Ring5' | 'Ring6' | 'Ring7' - `defaultCallScreen` 'Allow' | 'Block' | 'Voicemail' | 'Forward' | 'VipRing' | 'BlockWithPrompt' - `defaultRingType` 'StandardRing' | 'Ring1' | 'Ring2' | 'Ring3' | 'Ring4' | 'Ring5' | 'Ring6' | 'Ring7' - `customCallScreenList` CustomCallScreenX[] - `telephoneNumber` string - `blockType` 'Allow' | 'Block' | 'Voicemail' | 'Forward' | 'VipRing' | 'BlockWithPrompt' - `ringType` 'StandardRing' | 'Ring1' | 'Ring2' | 'Ring3' | 'Ring4' | 'Ring5' | 'Ring6' | 'Ring7' - `forwardTn` string - `newCppId` string - `mediaFriends` MediaFriendsX - `enabled` boolean - `host` string - `toNumber` string - `callHandlingSchedules` CallHandlingScheduleX[] - `schedule` ScheduleX - `name` string - `type` 'CUSTOM' | 'WEEKLY' - `weekly` object - `custom` CustomScheduleX[] - `date` string, date-time, required - `startTime` string, required - `endTime` string, required - `callHandling` CallHandlingSettingsX - `callWaitingEnabled` boolean - `doNotDisturbEnabled` boolean - `callHandlingOptionType` 'RingPhone' | 'ForwardAlways' | 'SimultaneousRing' | 'FindMeFollowMe' - `forwardAlwaysToNumber` string - `forwardAlwaysToNumberDescription` string - `ringPhoneCallHandling` RingPhoneCallHandlingX - `busyCallHandling` CallHandlingX - … - `noAnswerCallHandling` CallHandlingWithTimeoutX - … - `unregisteredCallHandling` CallHandlingX - … - `simultaneousRingCallHandling` SimultaneousRingCallHandlingX - `forwardToNumberList` string[] - `forwardToTimedNumberList` SimultaneousRingEndpointX[]: Mutually exclusive with forwardToNumberList; if both are sent, this list takes precedence when non-empty. Endpoint delays must be in chronological order with no gaps between active windows. The first endpoint delay must be less than or equal to noAnswerCallHandling.timeout. - … - `noAnswerCallHandling` CallHandlingWithTimeoutX - … - `continueOnBusy` boolean - `findMeFollowMeCallHandling` FindMeFollowMeCallHandlingX - `findMeEndpoints` FindMeEndpointX[] - … - `busyCallHandling` CallHandlingX - … - `timeoutType` 'Forward' | 'Voicemail' | 'Busy' | 'RingForever' - `forwardAlwaysToNumberType` 'Extension' | 'PhoneNumber' | 'ShortCode' - `voicemailBoxId` string - `endUserType` 'ADMIN' | 'ADVANCED_ADMIN' | 'BASIC_ADMIN' | 'STANDARD' | 'STANDARD_ADMIN' | 'SUPER_ADMIN' - `userProductPlan` 'STANDARD' | 'ADVANCED' | 'PROFESSIONAL' - `softphoneClientType` 'STRETTO' | 'CYMBUS' - `pinLockedOut` boolean - `privacySettings` EndUserPrivacySettingsX - `directoryPrivacyEnabled` boolean - `autoAttendantDialByExtensionPrivacyEnabled` boolean - `autoAttendantDialByNamePrivacyEnabled` boolean - `autoAnswerPrivacyEnabled` boolean - `welcomeEmailSent` string, date-time - `blockEmail` boolean - `allowPortalAccess` boolean - `tags` string - `group` UserGroupX - `id` string - `name` string - `description` string - `telephoneNumberAccounts` TelephoneNumberAccountV2X[]: Existing telephone numbers to assign to the user - `phoneNumber` string - `referenceType` 'SIP_TRUNK' | 'END_USER' | 'IVR' | 'LINE_APPEARANCE' | 'LINE_HUNTGROUP' | 'TELEPHONE' | 'VFAX' | 'BUSINESS_LINE' | 'BUSINESS_LINE_HUNT_GROUP' | 'CALL_GROUP' | 'CALL_QUEUE' | 'AUTO_ATTENDANT' | 'SPECIALTY_LINE' | 'CONTACT_CENTER': What kind of destination gets calls from this number. - `referenceId` string: The id of the destination which gets calls from this number. You can think of this as a variable refkey; what it points to depends on the referenceType. - `functionType` 'ELS' | 'TollFree' | 'TemporaryNumber' | 'SPTN' - `canAcceptSMS` boolean - `operationalStatus` 'ACTIVE' | 'STAGED' - `portId` string - `servicePackageType` 'Usage' | 'PrimaryLocalFlatRate' | 'PrimaryLocalAndDomesticLDFlatRate' | 'SecondaryLocalFlatRate' | 'SecondaryLocalAndDomesticLDFlatRate' - `accountId` string - `partitionId` string - `customerServiceRecord` CustomerServiceRecordX - `id` string - `firstName` string - `middleInitial` string - `lastName` string - `businessName` string - `streetNumber` string - `streetNumberSuffix` string - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `streetName` string - `streetSuffix` string - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `city` string - `state` string: A two-letter state abbreviation - `country` string: Alianza supports accounts in the USA and Canada. - `postalCode` string - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER' - `unit` string - `customerType` 'BUSINESS' | 'RESIDENTIAL' - `firstNameSecondary` string - `blockCustomerName` boolean - `customerName` string - `carrierStatus` 'ACTIVE' | 'ACTIVATION_ON_HOLD' | 'ACTIVATION_PENDING' | 'PORT_PENDING' | 'CANCEL_PORT' | 'CANCEL_PORT_EXPIDITED' | 'DELETE_PENDING' | 'DELETED' | 'CANCEL_PORT_COMPLETE' | 'PORT_REJECTED' | 'INVENTORY' | 'INVENTORY_CLAIMED' | 'COOLDOWN' | 'RECOVERED' - `orderVersion` string - `e911Address` E911AddressX - `id` string - `firstName` string - `middleInitial` string - `lastName` string - `businessName` string - `streetNumber` string - `streetNumberSuffix` string - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `streetName` string - `streetSuffix` string - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `city` string - `state` string - `country` string - `postalCode` string - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER' - `unit` string - `customerType` 'BUSINESS' | 'RESIDENTIAL' - `latitude` string: -90 through 90, 4-6 decimals - `longitude` string: -180 through 180, 4-6 decimals - `language` string: Optional, see /v2/ref/language for supported languages - `temporaryNumber` string - `directoryListing` DirectoryListingX - `listed` boolean - `type` 'ERROR' | 'LIST_PUBLISH' | 'LIST_NOT_PUBLISH' | 'NOT_LIST_NOT_PUBLISH' | 'PORTED' | 'COMPLEX': Indicates how a telephone number should be listed. - `address` AddressX - `id` string - `firstName` string - `middleInitial` string - `lastName` string - `businessName` string - `streetNumber` string - `streetNumberSuffix` string - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `streetName` string - `streetSuffix` string - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `city` string - `state` string: A two-letter state abbreviation - `country` string: Alianza supports accounts in USA and CAN - `postalCode` string - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER' - `unit` string - `assignAsCallerId` boolean - `byotnCarrierId` string - `ringType` 'StandardRing' | 'Ring1' | 'Ring2' | 'Ring3' | 'Ring4' | 'Ring5' | 'Ring6' | 'Ring7': Default ringtype for this phone - `carrierId` string - `tollFree` boolean - `id` string - `tags` string[]: Optional tags for categorizing the telephone number (e.g., location, service type). Tags are stored as attributes in the Attribute Service. Format is lowercase with hyphens replacing spaces. Maximum 10 tags per number. - `dynamicTelephoneNumberActivations` DynamicTelephoneNumberActivationX[]: New telephone numbers to provision from carrier - `partitionId` string - `accountId` string - `carrierId` string - `orderId` string - `tnQuantity` integer - `deviceId` string - `userId` string - `customerServiceRecord` LatLongCustomerServiceRecordX - `id` string - `firstName` string - `middleInitial` string - `lastName` string - `businessName` string - `streetNumber` string - `streetNumberSuffix` string - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `streetName` string - `streetSuffix` string - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `city` string - `state` string - `country` string - `postalCode` string - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER' - `unit` string - `customerType` 'BUSINESS' | 'RESIDENTIAL' - `firstNameSecondary` string - `blockCustomerName` boolean - `customerName` string - `latitude` number, double - `longitude` number, double - `directoryListing` DirectoryListingX - `listed` boolean - `type` 'ERROR' | 'LIST_PUBLISH' | 'LIST_NOT_PUBLISH' | 'NOT_LIST_NOT_PUBLISH' | 'PORTED' | 'COMPLEX': Indicates how a telephone number should be listed. - `address` AddressX - `id` string - `firstName` string - `middleInitial` string - `lastName` string - `businessName` string - `streetNumber` string - `streetNumberSuffix` string - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `streetName` string - `streetSuffix` string - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `city` string - `state` string: A two-letter state abbreviation - `country` string: Alianza supports accounts in USA and CAN - `postalCode` string - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER' - `unit` string - `e911Address` E911AddressX - `id` string - `firstName` string - `middleInitial` string - `lastName` string - `businessName` string - `streetNumber` string - `streetNumberSuffix` string - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `streetName` string - `streetSuffix` string - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `city` string - `state` string - `country` string - `postalCode` string - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER' - `unit` string - `customerType` 'BUSINESS' | 'RESIDENTIAL' - `latitude` string: -90 through 90, 4-6 decimals - `longitude` string: -180 through 180, 4-6 decimals - `language` string: Optional, see /v2/ref/language for supported languages - `tnSettings` TelephoneNumberAccountBareX - `phoneNumber` string - `referenceType` 'SIP_TRUNK' | 'END_USER' | 'IVR' | 'LINE_APPEARANCE' | 'LINE_HUNTGROUP' | 'TELEPHONE' | 'VFAX' | 'BUSINESS_LINE' | 'BUSINESS_LINE_HUNT_GROUP' | 'CALL_GROUP' | 'CALL_QUEUE' | 'AUTO_ATTENDANT' | 'SPECIALTY_LINE' | 'CONTACT_CENTER' - `referenceId` string - `functionType` 'ELS' | 'TollFree' | 'TemporaryNumber' | 'SPTN' - `canAcceptSMS` boolean - `operationalStatus` 'ACTIVE' | 'STAGED' - `portId` string - `servicePackageType` 'Usage' | 'PrimaryLocalFlatRate' | 'PrimaryLocalAndDomesticLDFlatRate' | 'SecondaryLocalFlatRate' | 'SecondaryLocalAndDomesticLDFlatRate' - `tollFree` boolean - `id` string - `tags` string[]: Optional tags for categorizing the telephone number (e.g., location, service type). Tags are stored as attributes in the Attribute Service. Format is lowercase with hyphens replacing spaces. Maximum 10 tags per number. - `ringType` 'StandardRing' | 'Ring1' | 'Ring2' | 'Ring3' | 'Ring4' | 'Ring5' | 'Ring6' | 'Ring7' - `archived` boolean - `alianzaOrderId` string - `smsSettings` SmsSettingsX - `smsLoaDocumentVersionId` string - `updatedAt` string, date-time - `campaignId` string - `smsLoa` FileDataBase64X - `contentType` string - `name` string - `contentBase64` string - `enableSMS` boolean - `createdAt` string, date-time - `authorizingPerson` string - `smsAction` 'CHANGE_CAMPAIGN' | 'DISABLE' | 'ENABLE' | 'PORT_COMPLETED' - `smsCarrierId` string - `campaignName` string - `remoteCampaignId` string - `id` string - `ports` PortX[]: Port-in requests for existing numbers - `id` string - `partitionId` string - `accountId` string - `telephoneNumbers` string[] - `status` 'ACTIVE' | 'ACTIVATION_ON_HOLD' | 'ACTIVATION_PENDING' | 'PORT_PENDING' | 'CANCEL_PORT' | 'CANCEL_PORT_EXPIDITED' | 'DELETE_PENDING' | 'DELETED' | 'CANCEL_PORT_COMPLETE' | 'PORT_REJECTED' | 'INVENTORY' | 'INVENTORY_CLAIMED' | 'COOLDOWN' | 'RECOVERED' - `sendLoa` boolean - `loaSaved` boolean - `carrierId` string - `carrierType` 'LEVEL_3' | 'NO_API' | 'E911' | 'TELUS' | 'TELUS_API' | 'TELUS_ONEVOICE' | 'PROVTEL' | 'VERIZON_CARIANZA' | 'ONVOY_CARIANZA' | 'LEVEL3_CARIANZA' | 'BANDWIDTH' | 'LUMEN_IMS' | 'LUMEN_VOICE_LI_ELS' | 'SINCH' | 'SERVICE_PROVIDER_CARRIER' - `customerServiceRecord` CustomerServiceRecordX - `id` string - `firstName` string - `middleInitial` string - `lastName` string - `businessName` string - `streetNumber` string - `streetNumberSuffix` string - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `streetName` string - `streetSuffix` string - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `city` string - `state` string: A two-letter state abbreviation - `country` string: Alianza supports accounts in the USA and Canada. - `postalCode` string - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER' - `unit` string - `customerType` 'BUSINESS' | 'RESIDENTIAL' - `firstNameSecondary` string - `blockCustomerName` boolean - `customerName` string - `crdDate` string, date-time - `billingTelephoneNumber` string - `portingWireType` 'Wireless' | 'Wireline' - `portingAuthorizedName` string - `wirelessAccountNumber` string - `wirelessPin` string - `focDate` string, date-time - `focDateTimeZone` 'US/Samoa' | 'US/Hawaii' | 'US/Alaska' | 'US/Pacific' | 'US/Arizona' | 'US/Mountain' | 'US/Central' | 'US/Eastern' | 'America/St_Thomas' | 'Canada/Pacific' | 'Canada/Mountain' | 'Canada/Central' | 'Canada/Eastern' | 'Canada/Atlantic' | 'Canada/Newfoundland' - `createdDate` string, date-time - `completedDate` string, date-time - `cancelType` 'NORMAL' | 'EXPIDITED' | 'BY_CARRIER' - `telecomSettings` TelecomSettingsX - `notes` string - `currentCarrier` string - `currentCarrierName` string - `localReseller` string - `loaDate` string, date-time - `disconnectInternetService` boolean - `disconnectTelevisionService` boolean - `tnData` object - `hotCutPortId` string - `portNow` boolean - `canAcceptSMS` boolean - `smsCallbackUrl` string - `smsSettings` SmsSettingsX - `smsLoaDocumentVersionId` string - `updatedAt` string, date-time - `campaignId` string - `smsLoa` FileDataBase64X - `contentType` string - `name` string - `contentBase64` string - `enableSMS` boolean - `createdAt` string, date-time - `authorizingPerson` string - `smsAction` 'CHANGE_CAMPAIGN' | 'DISABLE' | 'ENABLE' | 'PORT_COMPLETED' - `smsCarrierId` string - `campaignName` string - `remoteCampaignId` string - `tags` string[] - `holdActivation` boolean, required: Hold activation until ready ## Response `200` Successful operation - object - `success` boolean - `message` string ## Other responses - `400`: Invalid request parameters - `401`: Unauthorized - `404`: Not found - `500`: Internal server error --- [API](https://skmtc.dev/alianza/apis/alianza-public-api.md) - [All operations](https://skmtc.dev/alianza/apis/alianza-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/alianza/apis/alianza-public-api/revisions/7223246c352c?raw)