Register Brands and Agents

Before you can send messages, you need to set up a structure for your brand and your agents.

Brands and agents form the structural basis of your RCS communication: a Brand represents the overall identity of the company, while a Agent is the specific sender profile or chatbot that interacts with the end user.

By organizing your agents under a single brand, you can manage different services, such as support and marketing, with unique profiles but a consistent visual experience for the customer. The base URL for all calls is https://api.ip1.net/v3

Note: Currently, the ability to register Brands or agents via the API is limited. Please contact support@ip1.se to register your Brand as well as agents.

Brands

Quick Start

Below you will find an example of how to register an Agent

curl -X POST https://api.ip1.net/v3/brands \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"displayName": "My Store AB"}'

Endpoints - Brands

List all your registered Brands

Endpoint:/brands

Method:GET

Example of response data

{
  "brandName": "my-store-ltd",
  "displayName": "My Store Ltd",
  "created": "2026-03-04T10:00:00Z"
}

Register a new brand

Endpoint:/brands

Method:POST

Example of call data

{
  "displayName": "My Store Ltd"
}

Get details about a specific brand

Endpoint:/brands/{brandName}

Method:GET

Example of response data

{
  "brandName": "my-store-ltd",
  "displayName": "My Store Ltd",
  "created": "2026-03-04T10:00:00Z"
}

Delete a specific brand

Endpoint:/brands/{brandName}

Method:DELETE

Example of response data

{
  "brandName": "my-store-ltd",
  "displayName": "My Store Ltd",
  "created": "2026-03-04T10:00:00Z"
}

Fields for request data

Fields for response data

Agents

Quickstart

curl -X POST https://api.ip1.net/v3/brands/my-store-inc/agents \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "displayName": "Customer Service",
    "description": "We help you with your delivery questions.",
    "logoUri": "https://your-domain.com/assets/logo.png",
    "heroUri": "https://your-domain.com/assets/banner.png",
    "privacyUri": "https://your-domain.com/privacy",
    "termsUri": "https://your-domain.com/terms",
    "color": "#007AFF",
    "emailAdress": "support@your-domain.com",
    "websiteUri": "https://your-domain.com"
  }'

List agents linked to a brand

Endpoint:/brands/{brandName}/agents

Method:GET

Create a new agent

Endpoint:/brands/{brandName}/agents

Method:POST

Example of call data

{
  "displayName": "Customer service",
  "description": "We help you with your questions about delivery.",
  "logoUri": "https://your-site.com/logo.png",
  "heroUri": "https://your-site.com/banner.png",
  "color": "#FF5733",
  "privacyUri": "https://your-site.com/privacy",
  "termsUri": "https://your-site.com/terms"
}

Get details about a specific agent

Endpoint:/brands/{brandName}/agents/{name}

Method:GET

Example of response data

{
  "name": "customer service",
  "brandName": "my-store",
  "displayName": "Customer service",
  "description": "We help you with your questions.",
  "logoUri": "https://your-site.com/logo.png",
  "color": "#FF5733",
  "created": "2026-03-04T12:00:00Z"
}

Deletes a specific agent

Endpoint:/brands/{brandName}/agents/{name}

Method:DELETE

Example of response data

{
  "name": "customer service",
  "brandName": "my-store",
  "displayName": "Customer service",
  "description": "We help you with your questions.",
  "logoUri": "https://your-site.com/logo.png",
  "color": "#FF5733",
  "created": "2026-03-04T12:00:00Z"
}

Fields for request data

Fields for response data

Do you want to know more?

Read more about how verified senders work in our guide: