Manage applications and entities

View as Markdown

Use the web interface or API to manage your CPaaS X applications and entities. Changes sync immediately between the web interface and API. For a conceptual overview, see Applications and entities.

Create and view applications and entities [#create-applications-and-entities]

Create applications to organize your communications, and entities to represent your customers.

To create an application:

In the Infobip web interface, go to Developer tools > Applications and entities.
Select the Applications tab.
Select Create application.
In the Application ID field, enter a permanent ID (for example, production, marketing-campaigns). The ID cannot be changed later.
Optionally, in the Application name field, enter a display name (for example, Production Environment).
Select Create application.

To create an entity:

In the Infobip web interface, go to Developer tools > Applications and entities.
Select the Entities tab.
Select Create entity.
In the Entity ID field, enter a permanent ID (for example, customer-a, division-northamerica). The ID cannot be changed later.
Optionally, in the Entity name field, enter a display name (for example, Customer A Account).
Select Create entity.

To view applications and entities:

In the Infobip web interface, go to Developer tools > Applications and entities.
Toggle between the Applications and Entities tabs to browse your list.
Use the search and filter options to find specific applications or entities.

Use the Application and Entity Management API to:

Create an application or create an entity
Get all applications or get all entities with pagination
Get a specific application or get a specific entity by ID

The applicationId and entityId cannot be changed after creation. Entities auto-create when referenced in a message submit if they do not yet exist.

Update applications and entities [#update-applications-and-entities]

Modify the display name of applications and entities. The applicationId and entityId cannot be changed after creation.

To update an application:

In the Infobip web interface, go to Developer tools > Applications and entities.
Select the Applications tab.
Select the application ID link to open the detail page.
Select Edit application.
Update the Application name field as needed.
Select Save.

To update an entity:

In the Infobip web interface, go to Developer tools > Applications and entities.
Select the Entities tab.
Select the entity ID link to open the detail page.
Select Edit entity.
Update the Entity name field as needed.
Select Save.

Use the Application and Entity Management API to:

Modify an application: Change the display name
Modify an entity: Change the display name

Only the display name can be modified. The applicationId and entityId are permanent.

Delete applications and entities [#delete-applications-and-entities]

Remove applications or entities when they are no longer needed. Deletion is permanent.

To delete an application:

In the Infobip web interface, go to Developer tools > Applications and entities.
Select the Applications tab.
Find your application in the list.
Select the Delete icon .
In the confirmation dialog, select Confirm.

To delete an entity:

In the Infobip web interface, go to Developer tools > Applications and entities.
Select the Entities tab.
Find your entity in the list.
Select the Delete icon .
In the confirmation dialog, select Confirm.

Use the Application and Entity Management API to:

Linked resources are reset to application = default and entity = null. Reassign any configurations before deleting.

IMPORTANT

Deletion is irreversible. Linked resources are reset to application = default and entity = null. Before deleting, reassign any related configurations (resource associations, inbound message configurations, subscriptions, bots, API keys) to other applications or entities.

Learn more

Explore the full Application and Entity Management API for all available endpoints, request/response schemas, and filtering options.

Related pages

Applications and entities
Core concepts and organizational hierarchy.

Get started with CPaaS X
End-to-end setup tutorial.

Configure sending strategies
Set up resource associations and routing rules.

Secure your CPaaS X setup
Scope API keys for access control.