Brand Account Endpoints
GET a single Brand details
This endpoint will retrieve the brand account admin details for account id, company name, email, website, language, timezone, and EIN info.
Endpoint | /api/v1.0/brand |
---|---|
Method | GET |
Request Headers | Content-Type : application/json |
Request Body | N/A |
Response Body Sample
[
{
"id": 3242,
"language": "en-us",
"timezone": "(UTC-06:00) Central Time (US and Canada)",
"name": "ABC Brand",
"email": "abcbrand@domain.com",
"website": "www.abcbrand.com",
"ein": "1234567890"
}
]
PUT Update Brand Account
This updates an existing brand account information.
Endpoint | /api/v1.0/brand |
---|---|
Method | PUT |
Request Headers | Content-Type : application/json |
Response Body | N/A |
Request Body Sample
{
"Name": "ABC Brand",
"Website": "www.abc.com",
"Email": "demo@abcbrand.com",
"Timezone": "(UTC-06:00) Central Time (US and Canada)",
"EIN": "N1232202",
"Language": "en-us"
}
GET Timezones
This retrieves a list of timezones used in the Aprimo platform
Endpoint | /api/v1.0/master/timezone |
---|---|
Method | GET |
Request Headers | Content-Type : application/json |
Request Body | N/A |
Response Body Sample
[
{
"id": 11,
"title": "(UTC-06:00) Central America"
},
{
"id": 12,
"title": "(UTC-06:00) Central Time (US and Canada)"
},
{
"id": 10,
"title": "(UTC-06:00) Saskatchewan"
},
{
"id": 9,
"title": "(UTC-07:00) Arizona"
},
{
"id": 8,
"title": "(UTC-07:00) Chihuahua, La Paz, Mazatlan"
},
{
"id": 7,
"title": "(UTC-07:00) Mountain Time (US and Canada)"
},
{
"id": 5,
"title": "(UTC-08:00) Pacific Time (US and Canada)"
},
{
"id": 6,
"title": "(UTC-08:00)Baja California"
},
{
"id": 4,
"title": "(UTC-09:00) Alaska"
},
{
"id": 3,
"title": "(UTC-10:00) Hawaii"
},
{
"id": 2,
"title": "(UTC-11:00) Coordinated Universal Time -11"
},
{
"id": 99,
"title": "(UTC-11:00)Samoa"
},
{
"id": 1,
"title": "(UTC-12:00) International Date Line West"
}
]
GET Languages
This endpoint will retrieve a list of Aprimo platform UX languages. This is for the brand user preferred platform language setting in the user profile.
Endpoint | /api/v1.0/master/language |
---|---|
Method | GET |
Request Headers | Content-Type : application/json |
Request Body | N/A |
Response Body Sample
[
{
"id": 2,
"title": "de-de"
},
{
"id": 1,
"title": "en-us"
},
{
"id": 4,
"title": "es-es"
},
{
"id": 3,
"title": "fr-fr"
},
{
"id": 13,
"title": "pt-br"
},
{
"id": 5,
"title": "ja"
},
{
"id": 8,
"title": "zh-chs"
}
]
GET Brand Territory
This endpoint will retrieve a list of territory options setup by the brand.
Endpoint | /api/v1.0/master/territory |
---|---|
Method | GET |
Request Headers | Content-Type : application/json |
Request Body | N/A |
Response Body Sample
[
{
"id": 3,
"title": "APAC"
},
{
"id": 4,
"title": "EMEA"
},
{
"id": 5,
"title": "Japan"
},
{
"id": 6,
"title": "LATAM"
},
{
"id": 7,
"title": "NA"
},
{
"id": 8,
"title": "Northeast USA"
},
{
"id": 9,
"title": "Western Canada"
}
]
GET Brand Locations
This endpoint will retrieve a list of locations setup by the brand. These are used to tag a brand user to a specific location.
Endpoint | /api/v1.0/master/location |
---|---|
Method | GET |
Request Headers | Content-Type : application/json |
Request Body | N/A |
Response Body Sample
[
{
"id": 295,
"title": "Chicago"
},
{
"id": 296,
"title": "Atlanta"
}
]
GET Account Access
This endpoint will retrieve a list of account access roles available in Aprimo. These are used to define what feature access a particular brand user will be given
Endpoint | /api/v1.0/master/accountaccess |
---|---|
Method | GET |
Request Headers | Content-Type : application/json |
Request Body | N/A |
Response Body Sample
[
{
"id": 6,
"title": "Account Manager"
},
{
"id": 37,
"title": "Agency"
},
{
"id": 15,
"title": "Association Approver"
},
{
"id": 16,
"title": "Central Fund Manager"
},
{
"id": 17,
"title": "Channel Manager"
},
{
"id": 3,
"title": "Employee"
},
{
"id": 45,
"title": "Engagement Manager"
},
{
"id": 41,
"title": "Marketing Concierge"
},
{
"id": 4,
"title": "National Manager"
},
{
"id": 5,
"title": "Regional Manager"
}
]
GET Business Roles
This endpoint will retrieve a list of business roles in Aprimo. This is used to assign a n optional business role to a brand user
Endpoint | /api/v1.0/master/businessrole |
---|---|
Method | GET |
Request Headers | Content-Type : application/json |
Request Body | N/A |
Response Body Sample
[
{
"id": 3,
"title": "Marketing"
},
{
"id": 4,
"title": "Procurement"
},
{
"id": 6,
"title": "Sales"
},
{
"id": 7,
"title": "Services"
},
{
"id": 8,
"title": "Support"
},
{
"id": 9,
"title": "Technical"
}
]