API Documentation
Applications ¶
A brand may register external applications (e.g. Contact or Deal apps) that can later be referenced from other parts of the platform — for example, by SSO applications whose authentication_type is Application.
Each application belongs to a brand and has an application_type of Contact, Contacts, Deal, Generic, or Integration.
Create an application ¶
Create an applicationPOST/brands/:brand/applications
Creates an application under the given brand. The body must include a url and an application_type (Contact, Contacts, Deal, Generic, or Integration).
Example URI
POST /brands/:brand/applications
URI Parameters
- brand
string(required) Example: 9bb2ab61-9671-4e88-8008-a0eb142eb59c
Request
Body
{
"url": "https://example.com/app",
"application_type": "Deal"
}Response
200Body
{
"code": "OK",
"data": {
"id": "f59ca2da-98f0-42a8-8222-f4a966226277",
"created_at": 1792423413.108866,
"updated_at": 1792423413.108866,
"deleted_at": null,
"url": "https://example.com/app",
"application_type": "Deal",
"brand": "9bb2ab61-9671-4e88-8008-a0eb142eb59c",
"type": "application"
}
}Get applications for a brand ¶
Get applications for a brandGET/brands/:brand/applications
Example URI
GET /brands/:brand/applications
URI Parameters
- brand
string(required) Example: 9bb2ab61-9671-4e88-8008-a0eb142eb59c
Response
200Body
{
"code": "OK",
"data": [
{
"id": "f59ca2da-98f0-42a8-8222-f4a966226277",
"created_at": 1792423413.108866,
"updated_at": 1792423413.108866,
"deleted_at": null,
"url": "https://example.com/app",
"application_type": "Deal",
"brand": "9bb2ab61-9671-4e88-8008-a0eb142eb59c",
"type": "application"
}
],
"info": {
"count": 1,
"total": 0
}
}