Amazon Web Services, Inc.

AWS End User Messaging

AWS End User Messaging provides a set of APIs to manage brand profiles, synchronize brand profile data with SMS and Rich Communication Services (RCS)…

Communication#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

AWS End User Messaging provides a set of APIs to manage brand profiles, synchronize brand profile data with SMS and Rich Communication Services (RCS) registrations, and send and validate one-time passcodes across the SMS, voice, and WhatsApp channels.

Endpoints 27

  • GETList brand profiles/v1/brand-profiles?nextToken=string&maxResults=0Retrieves a paginated list of the brand profiles in your account. Use the nextToken parameter to retrieve additional results.
  • POSTCreate brand profile/v1/brand-profilesCreates a brand profile. A brand profile is a lightweight container that holds your brand identity information as flexible attributes. After you create a…
  • GETList brand profile attributes/v1/brand-profiles/:brandProfileId/attributes?nextToken=string&maxResults=0Retrieves a paginated list of the attributes for a brand profile.
  • POSTCreate brand profile attributes/v1/brand-profiles/:brandProfileId/attributesCreates up to 10 attributes for a brand profile in a single request. For attributes of type IMAGE or DOCUMENT, the response includes a presigned Amazon S3 URL…
  • POSTCreate brand profile from registration/v1/brand-profiles/create-from-registrationCreates a brand profile and populates its attributes from an existing registration. This operation runs asynchronously. Use the GetJob operation to track its…
  • GETList notify code configurations/v1/notify-code-configurations?maxResults=0&nextToken=stringRetrieves a paginated list of the notify code configurations in your account.
  • POSTCreate notify code configuration/v1/notify-code-configurationsCreates a notify code configuration. A notify code configuration is a reusable policy that defines how one-time passcodes are generated and rendered,…
  • POSTCreate registrations from brand profile/v1/brand-profiles/:brandProfileId/create-registrationsCreates one or more registrations in the DRAFT state and prefills their fields from the attributes of a brand profile. This operation runs asynchronously. Use…
  • GETGet brand profile/v1/brand-profiles/:brandProfileIdRetrieves the metadata for a brand profile, including its name, status, deletion protection setting, and timestamps. To retrieve the attributes of the…
  • PUTUpdate brand profile/v1/brand-profiles/:brandProfileIdUpdates the name or the deletion protection setting of a brand profile. To change the information that is stored in the profile, use the brand profile…
  • DELETEDelete brand profile/v1/brand-profiles/:brandProfileIdDeletes a brand profile. This operation also deletes the attributes of the profile and any associated media. The request fails if deletion protection is…
  • GETGet brand profile attribute/v1/brand-profiles/:brandProfileId/attributes/:attributeNameRetrieves a single brand profile attribute.
  • PUTUpdate brand profile attribute/v1/brand-profiles/:brandProfileId/attributes/:attributeNameUpdates the value, description, or category of an existing brand profile attribute.
  • DELETEDelete brand profile attribute/v1/brand-profiles/:brandProfileId/attributes/:attributeNameDeletes a brand profile attribute. If the attribute stores media, this operation also deletes the associated media.
  • GETGet notify code configuration/v1/notify-code-configurations/:notifyCodeConfigurationIdRetrieves a notify code configuration.
  • PUTUpdate notify code configuration/v1/notify-code-configurations/:notifyCodeConfigurationIdUpdates the mutable fields of a notify code configuration. Only the fields that you supply are changed. For the template and language fields, supplying an…
  • DELETEDelete notify code configuration/v1/notify-code-configurations/:notifyCodeConfigurationIdDeletes a notify code configuration. Verifications that are already in progress are not affected, because they capture the policy at the time that the…
  • GETGet job/v1/jobs/:jobIdRetrieves the current state of an asynchronous job, including its status and any resources that it created or updated.
  • GETList jobs/v1/jobs?maxResults=0&nextToken=string&status=string&brandProfileId=string&operationType=stringRetrieves a paginated list of the asynchronous jobs in your account. You can filter the results by status, brand profile, or operation type.
  • GETList registrations from brand profile/v1/brand-profiles/:brandProfileId/registrations?maxResults=0&nextToken=stringRetrieves a paginated list of the registrations that were created from a brand profile through the synchronization operations.
  • GETList tags for resource/v1/tags/:resourceArnRetrieves the tags that are associated with a resource.
  • POSTTag resource/v1/tags/:resourceArnAdds or overwrites the tags on a resource.
  • DELETEUntag resource/v1/tags/:resourceArn?tagKeys=Removes the specified tags from a resource.
  • POSTSend notify code verification/v1/notify-code-verifications/sendGenerates a one-time passcode and delivers it to a recipient over the requested channel. The passcode policy is captured from the referenced notify code…
  • POSTUpdate brand profile from registration/v1/brand-profiles/:brandProfileId/update-from-registrationImports or refreshes the attributes of an existing brand profile from an existing registration. This operation runs asynchronously. Use the GetJob operation…
  • POSTUpdate registrations from brand profile/v1/brand-profiles/:brandProfileId/update-registrationsRepushes the attributes of a brand profile into existing DRAFT registrations. This operation runs asynchronously. Use the GetJob operation to track its…
  • POSTValidate notify code verification/v1/notify-code-verifications/validateValidates a one-time passcode that a recipient submitted. Validation succeeds when the passcode matches, the validity period has not elapsed, and the maximum…

API details

Base URL
https://end-user-messaging.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
27 operations on 16 pathsGET 10POST 10DELETE 4PUT 3
Description format
AWS Smithy model, API version 2026-09-21

How to test the AWS End User Messaging in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS End User Messaging collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List brand profiles” (GET /v1/brand-profiles?nextToken=string&maxResults=0), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS End User Messaging?

AWS End User Messaging provides a set of APIs to manage brand profiles, synchronize brand profile data with SMS and Rich Communication Services (RCS)… It is listed under Communication and has 27 endpoints.

Who publishes the AWS End User Messaging?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS End User Messaging?

Requests go to https://end-user-messaging.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS End User Messaging?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS End User Messaging have?

27 operations on 16 paths (10 GET, 10 POST, 4 DELETE, 3 PUT).

Is forking the AWS End User Messaging free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.