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
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/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
Methodology: GET
Example of response data
{
"brandName": "min-store-ab",
"displayName": "Min Butik AB",
"created": "2026-03-04T10:00:00Z"
}Register a new brand #
Endpoint: /brands
Methodology: POST
Example of call data
{
"displayName": "Min Butik AB"
}Get details about a specific brand #
Endpoint: /brands/{brandName}
Methodology: GET
Example of response data
{
"brandName": "min-store-ab",
"displayName": "Min Butik AB",
"created": "2026-03-04T10:00:00Z"
}Delete a specific brand #
Endpoint: /brands/{brandName}
Methodology: DELETE
Example of response data
{
"brandName": "min-store-ab",
"displayName": "Min Butik AB",
"created": "2026-03-04T10:00:00Z"
}Fields for request data #
| Field name | Description of the project | Required | Type | Example |
| displayName | The name of the agent visible in the chat | Yes | string | "Customer service" |
Fields for response data #
| Field name | Description of the project | Type | Example |
| brand name | Internal system ID/brand name. | string | "my-store-ab" |
| displayName | The display name specified at creation. | string | ”Min Butik AB” |
| created | Time when the fire was recorded. | DateTime | ”2026-03-04T10:00:00Z” |
Agents #
Quickstart #
curl -X POST https://api.ip1.net/brands/min-butik-ab/agents \
-H "Authorization: Bearer DIN_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"displayName": "Customer Service",
"description": "We help you with your delivery questions.",
"logoUri": "https://din-doman.se/assets/logo.png",
"heroUri": "https://din-doman.se/assets/banner.png",
"privacyUri": "https://din-doman.se/privacy",
"termsUri": "https://din-doman.se/terms",
"color": "#007AFF",
"emailAdress": "support@din-doman.se",
"websiteUri": "https://din-doman.se"
}'List agents linked to a brand #
Endpoint: /brands/{brandName}/agents
Methodology: GET
Create a new agent #
Endpoint: /brands/{brandName}/agents
Methodology: POST
Example of call data
{
"displayName": "Customer service",
"description": "We help you with your questions about delivery.",
"logoUri": "https://din-sida.se/logo.png",
"heroUri": "https://din-sida.se/banner.png",
"color": "#FF5733",
"privacyUri": "https://din-sida.se/privacy",
"termsUri": "https://din-sida.se/terms"
}Get details about a specific agent #
Endpoint: /brands/{brandName}/agents/{name}
Methodology: GET
Example of response data
{
"name": "customer service",
"brandName": "my-store",
"displayName": "Customer service",
"description": "We help you with your questions.",
"logoUri": "https://din-sida.se/logo.png",
"color": "#FF5733",
"created": "2026-03-04T12:00:00Z"
}Deletes a specific agent #
Endpoint: /brands/{brandName}/agents/{name}
Methodology: DELETE
Example of response data
{
"name": "customer service",
"brandName": "my-store",
"displayName": "Customer service",
"description": "We help you with your questions.",
"logoUri": "https://din-sida.se/logo.png",
"color": "#FF5733",
"created": "2026-03-04T12:00:00Z"
}Fields for request data #
| Field name | Description of the project | Required | Type | Example |
| displayName | The name of the agent visible in the chat | Yes | string | "Customer service" |
| description | A brief description of the agent's purpose. | Yes | string | ”We help you with order questions” |
| logoUri | URL of the agent's logo (square). | Yes | URI | ”https://cdn.se/logo.png” |
| heroUri | URL to the large banner image in the profile. | Yes | URI | ”https://cdn.se/hero.png” |
| color | Chat theme color (Hex code). Must start with # (e.g., #89B642) | Yes | string | ”#89B642” |
| privacyUri | Link to the privacy policy. | Yes | URI | ”https://site.se/privacy” |
| termsUri | Link to the terms of use. | Yes | URI | ”https://site.se/terms” |
| emailAdress | Contact email for the agent. | No, it is not. | string | ”support@butik.se” |
Fields for response data #
| Field name | Description of the project | Type | Example |
| name | The internal system ID of the agent. | string | "customer service" |
| brand name | The name of the brand to which the agent belongs. | string | ”my-store-ab” |
| displayName | The name displayed on the user's phone. | string | ”Customer service” |
| description | The description of the agent. | string | ”We help you with orders.” |
| logoUri | Public link to the logo. | URI | ”https://cdn.se/logo.png” |
| color | The selected theme color (Hex). | string | ”#FF5733” |
| created | Time when the agent was created. | DateTime | ”2026-03-04T12:00:00Z” |