APIHub
Back to Explore

Alexa For Business

The Alexa for Business API provides programmatic control over an organization’s Alexa ecosystem, allowing you to create, retrieve, update, and delete resources such as rooms, devices, users, contacts, address books, skill groups, conference providers, network profiles, and smart‑home appliances, as well as manage skill associations, conference preferences, invitations, and usage reports.

Cloud
apiKeyHeader
No HTTPS
CORS: Unknown
Description enriched …
Visit official documentation

Latency

257ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
POST

/#X-Amz-Target=AlexaForBusiness.CreateRoom

Creates a room with the specified details.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.CreateSkillGroup

Creates a skill group with a specified name and description.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.CreateUser

Creates a user.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.CreateConferenceProvider

Adds a new conference provider under the user's AWS account.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.CreateContact

Creates a contact with the specified details.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.CreateGatewayGroup

Creates a gateway group with the specified details.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.CreateNetworkProfile

Creates a network profile with the specified details.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.CreateProfile

Creates a new room profile with the specified details.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.ApproveSkill

Associates a skill with the organization under the customer's AWS account. If a skill is private, the user implicitly accepts access to this skill during enablement.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.AssociateContactWithAddressBook

Associates a contact with a given address book.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.AssociateDeviceWithNetworkProfile

Associates a device with the specified network profile.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.AssociateDeviceWithRoom

Associates a device with a given room. This applies all the settings from the room profile to the device, and all the skills in any skill groups added to that room. This operation requires the device to be online, or else a manual sync is required.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.AssociateSkillGroupWithRoom

Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.AssociateSkillWithSkillGroup

Associates a skill with a skill group.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.AssociateSkillWithUsers

Makes a private skill available for enrolled users to enable on their devices.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.CreateAddressBook

Creates an address book with the specified details.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.CreateBusinessReportSchedule

Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.DeleteAddressBook

Deletes an address book by the address book ARN.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.DeleteBusinessReportSchedule

Deletes the recurring report delivery schedule with the specified schedule ARN.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.DeleteConferenceProvider

Deletes a conference provider.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.DeleteContact

Deletes a contact by the contact ARN.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.DeleteDevice

Removes a device from Alexa For Business.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.DeleteDeviceUsageData

When this action is called for a specified shared device, it allows authorized users to delete the device's entire previous history of voice input data and associated response data. This action can be called once every 24 hours for a specific shared device.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.DeleteGatewayGroup

Deletes a gateway group.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.DeleteNetworkProfile

Deletes a network profile by the network profile ARN.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.DeleteProfile

Deletes a room profile by the profile ARN.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.DeleteRoom

Deletes a room by the room ARN.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.DeleteRoomSkillParameter

Deletes room skill parameter details by room, skill, and parameter key ID.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.DeleteSkillAuthorization

Unlinks a third-party account from a skill.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.DeleteSkillGroup

Deletes a skill group by skill group ARN.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.DeleteUser

Deletes a specified user by user ARN and enrollment ARN.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.DisassociateContactFromAddressBook

Disassociates a contact from a given address book.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.DisassociateDeviceFromRoom

Disassociates a device from its current room. The device continues to be connected to the Wi-Fi network and is still registered to the account. The device settings and skills are removed from the room.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.DisassociateSkillFromSkillGroup

Disassociates a skill from a skill group.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.DisassociateSkillFromUsers

Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.DisassociateSkillGroupFromRoom

Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.ForgetSmartHomeAppliances

Forgets smart home appliances associated to a room.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.GetAddressBook

Gets address the book details by the address book ARN.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.GetConferencePreference

Retrieves the existing conference preferences.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.GetConferenceProvider

Gets details about a specific conference provider.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.GetContact

Gets the contact details by the contact ARN.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.GetDevice

Gets the details of a device by device ARN.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.GetGateway

Retrieves the details of a gateway.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.GetGatewayGroup

Retrieves the details of a gateway group.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.GetInvitationConfiguration

Retrieves the configured values for the user enrollment invitation email template.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.GetNetworkProfile

Gets the network profile details by the network profile ARN.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.GetProfile

Gets the details of a room profile by profile ARN.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.GetRoom

Gets room details by room ARN.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.GetRoomSkillParameter

Gets room skill parameter details by room, skill, and parameter key ARN.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.GetSkillGroup

Gets skill group details by skill group ARN.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.ListBusinessReportSchedules

Lists the details of the schedules that a user configured. A download URL of the report associated with each schedule is returned every time this action is called. A new download URL is returned each time, and is valid for 24 hours.

  • MaxResults (query, limit) — Pagination limit
  • NextToken (query) — Pagination token
  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.ListConferenceProviders

Lists conference providers under a specific AWS account.

  • MaxResults (query, limit) — Pagination limit
  • NextToken (query) — Pagination token
  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.ListDeviceEvents

Lists the device event history, including device connection status, for up to 30 days.

  • MaxResults (query, limit) — Pagination limit
  • NextToken (query) — Pagination token
  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.ListGatewayGroups

Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.

  • MaxResults (query, limit) — Pagination limit
  • NextToken (query) — Pagination token
  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.ListGateways

Retrieves a list of gateway summaries. Use GetGateway to retrieve details of a specific gateway. An optional gateway group ARN can be provided to only retrieve gateway summaries of gateways that are associated with that gateway group ARN.

  • MaxResults (query, limit) — Pagination limit
  • NextToken (query) — Pagination token
  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.ListSkills

Lists all enabled skills in a specific skill group.

  • MaxResults (query, limit) — Pagination limit
  • NextToken (query) — Pagination token
  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.ListSkillsStoreCategories

Lists all categories in the Alexa skill store.

  • MaxResults (query, limit) — Pagination limit
  • NextToken (query) — Pagination token
  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.ListSkillsStoreSkillsByCategory

Lists all skills in the Alexa skill store by category.

  • MaxResults (query, limit) — Pagination limit
  • NextToken (query) — Pagination token
  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.ListSmartHomeAppliances

Lists all of the smart home appliances associated with a room.

  • MaxResults (query, limit) — Pagination limit
  • NextToken (query) — Pagination token
  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.ListTags

Lists all tags for the specified resource.

  • MaxResults (query, limit) — Pagination limit
  • NextToken (query) — Pagination token
  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.PutConferencePreference

Sets the conference preferences on a specific conference provider at the account level.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.PutInvitationConfiguration

Configures the email template for the user enrollment invitation with the specified attributes.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.PutRoomSkillParameter

Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.PutSkillAuthorization

Links a user's account to a third-party skill provider. If this API operation is called by an assumed IAM role, the skill being linked must be a private skill. Also, the skill must be owned by the AWS account that assumed the IAM role.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.RegisterAVSDevice

Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.RejectSkill

Disassociates a skill from the organization under a user's AWS account. If the skill is a private skill, it moves to an AcceptStatus of PENDING. Any private or public skill that is rejected can be added later by calling the ApproveSkill API.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.ResolveRoom

Determines the details for the room from which a skill request was invoked. This operation is used by skill developers. To query ResolveRoom from an Alexa skill, the skill ID needs to be authorized. When the skill is using an AWS Lambda function, the skill is automatically authorized when you publish your skill as a private skill to your AWS account. Skills that are hosted using a custom web service must be manually authorized. To get your skill authorized, contact AWS Support with your AWS account ID that queries the ResolveRoom API and skill ID.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.RevokeInvitation

Revokes an invitation and invalidates the enrollment URL.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.SearchAddressBooks

Searches address books and lists the ones that meet a set of filter and sort criteria.

  • MaxResults (query, limit) — Pagination limit
  • NextToken (query) — Pagination token
  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.SearchContacts

Searches contacts and lists the ones that meet a set of filter and sort criteria.

  • MaxResults (query, limit) — Pagination limit
  • NextToken (query) — Pagination token
  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.SearchDevices

Searches devices and lists the ones that meet a set of filter criteria.

  • MaxResults (query, limit) — Pagination limit
  • NextToken (query) — Pagination token
  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.SearchNetworkProfiles

Searches network profiles and lists the ones that meet a set of filter and sort criteria.

  • MaxResults (query, limit) — Pagination limit
  • NextToken (query) — Pagination token
  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.SearchProfiles

Searches room profiles and lists the ones that meet a set of filter criteria.

  • MaxResults (query, limit) — Pagination limit
  • NextToken (query) — Pagination token
  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.SearchRooms

Searches rooms and lists the ones that meet a set of filter and sort criteria.

  • MaxResults (query, limit) — Pagination limit
  • NextToken (query) — Pagination token
  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.SearchSkillGroups

Searches skill groups and lists the ones that meet a set of filter and sort criteria.

  • MaxResults (query, limit) — Pagination limit
  • NextToken (query) — Pagination token
  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.SearchUsers

Searches users and lists the ones that meet a set of filter and sort criteria.

  • MaxResults (query, limit) — Pagination limit
  • NextToken (query) — Pagination token
  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.SendAnnouncement

Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.SendInvitation

Sends an enrollment invitation email with a URL to a user. The URL is valid for 30 days or until you call this operation again, whichever comes first.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.StartDeviceSync

Resets a device and its account to the known default settings. This clears all information and settings set by previous users in the following ways: Bluetooth - This unpairs all bluetooth devices paired with your echo device. Volume - This resets the echo device's volume to the default value. Notifications - This clears all notifications from your echo device. Lists - This clears all to-do items from your echo device. Settings - This internally syncs the room's profile (if the device is assigned to a room), contacts, address books, delegation access for account linking, and communications (if enabled on the room profile).

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.StartSmartHomeApplianceDiscovery

Initiates the discovery of any smart home appliances associated with the room.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.TagResource

Adds metadata tags to a specified resource.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.UntagResource

Removes metadata tags from a specified resource.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.UpdateAddressBook

Updates address book details by the address book ARN.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.UpdateBusinessReportSchedule

Updates the configuration of the report delivery schedule with the specified schedule ARN.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.UpdateConferenceProvider

Updates an existing conference provider's settings.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.UpdateContact

Updates the contact details by the contact ARN.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.UpdateDevice

Updates the device name by device ARN.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.UpdateGateway

Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.UpdateGatewayGroup

Updates the details of a gateway group. If any optional field is not provided, the existing corresponding value is left unmodified.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.UpdateNetworkProfile

Updates a network profile by the network profile ARN.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.UpdateProfile

Updates an existing room profile by room profile ARN.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.UpdateRoom

Updates room details by room ARN.

  • X-Amz-Target (header, required)
POST

/#X-Amz-Target=AlexaForBusiness.UpdateSkillGroup

Updates skill group details by skill group ARN.

  • X-Amz-Target (header, required)

93 endpoints auto-detected

Authentication

This API uses an API key, passed in the "Authorization" header. No OAuth required.

curl -X POST \
  "https://github.com/mermade/aws2openapi/#X-Amz-Target=AlexaForBusiness.CreateRoom" \
  -H "Authorization: YOUR_API_KEY"

github.com · HTTPS only