Home / Distributed Marketing / REST API / Brand Endpoints / Brand User Endpoints

Distributed Marketing

Brand User Endpoints

POST Create Brand User

Create a new brand user

 

Endpoint /api/v1.0/branduser
Method POST
Request Headers Content-Type : application/json

Request Body Sample

{  
   "FirstName":"Pam",
   "LastName":"Henderson",
   "Title":"Director",
   "Email": "acmedemo@domain.com",
   "Phone":"555-555-5555",
   "PhoneExt":"112",
   "Territory": "US", 
   "Location": "San Diego Office", 
   "EIN": "N123456789", 
   "Language": "English(US)", 
   "AccountAccess": ["Account Manager"], 
   "BusinessRole": ["Marketing"], 
   "IsPrimaryContact":false, 
   "AboutMe":"Lorem ipsum dolor sit amet consectetur adipiscing elite. ", 
   "DigitalProfilePicture":"", 
   "IsOptimizeForWeb":false 
}

Response Body Sample


{  
    "digitalProfilePicture": "",
    "id": 12345,
    "accountAccess": [
        "Channel Manager",
        "Agency"
    ],
    "businessRole": [
        "Marketing",
        "Sales"
    ],
    "firstName": "Pam",
    "lastName": "Henderson",
    "email": "acmedemo64@aprimo.com",
    "location": "San Diego Office",
    "territory": "US",
    "phone": "312-888-4700",
    "phoneExt": "112",
    "language": "English(US)",
    "isPrimaryContact": false,
    "aboutMe": "",
    "title": "Channel Marketer - West"
}

PATCH Update Brand User account

This updates an existing brand user’s account information.

Endpoint /api/v1.0/branduser/{id}
Method PATCH
Request Headers Content-Type : application/json
Response Body N/A

Request Body Sample


{  
   "FirstName":"Pam",
   "LastName":"Henderson" 
}

Request Body Sample


{  
   BusinessRole": ["Marketing", "Sales"]
}

Request Body Sample


{  
   "IsPrimaryContact": false
}

Response Body Sample


{
"digitalProfilePicture": "",
"id": 12345,
"accountAccess": [
"Channel Manager",
"Agency"
],
"businessRole": [
"Marketing",
"Sales"
],
"firstName": "James",
"lastName": "Smith",
"email": "james.smith@domain.com",
"location": "Atlanta",
"territory": "Territory 1",
"phone": "870-345-4534",
"phoneExt": "123",
"language": null,
"isPrimaryContact": false,
"aboutMe": "Demo content",
"title": "Manager"
}

PUT Update Brand User Account Access

This updates an existing brand user’s account access

Endpoint /api/v1.0/branduser/{id}/accountaccess
Method PUT
Request Headers Content-Type : application/json
Response Body N/A

Request Body Sample

{  
    "AccountAccess": [ 
        "Account Manager", 
        "Agency" 
    ] 
}

PUT Update Brand User Business Role

This updates an existing brand user’s business rol

Endpoint /api/v1.0/branduser/{id}/businessrole
Method PUT
Request Headers Content-Type : application/json
Response Body N/A

Request Body Sample

{  
    "BusinessRole": [ 
        "Marketing", 
        "Sales" 
    ] 
}

PUT Update Brand User Status

This updates an existing brand user’s account status which controls their ability to login to the Aprimo Distributed Marketing Platform

  • Valid status options are:  “Active” or “Inactive”
    • Active indicates the user can have access to login to Aprimo
    • Inactive will prevent user from being able to login to Aprimo

 

Endpoint /api/v1.0/branduser/{id}/status
Method PUT
Request Headers Content-Type : application/json
Response Body N/A

Request Body Sample

{  
   "status":"Active" 
}

DELETE Brand User account

This will remove an existing brand user’s account from the Aprimo Distributed Marketing Platform.

 

Endpoint /api/v1.0/branduser/{id}
Method DELETE
Request Headers Content-Type : application/json
Request Body N/A
Response Body N/A

GET a list of Brand contacts

This endpoint will retrieve a list of all brand contacts

 

Endpoint /api/v1.0/branduser
Method GET
Request Headers Content-Type : application/json
Request Body N/A

Response Body Sample

  
[
    {
        "id": 12345,
        "accountAccess": [
            "Channel Manager",
            "Agency"
        ],
        "businessRole": [
            "Marketing",
            "Sales"
        ],
        "firstName": "James",
        "lastName": "Smith",
        "email": "james.smith@domain.com",
        "location": "Atlanta",
        "territory": "Territory 1",
        "phone": "870-345-4534",
        "phoneExt": "123",
        "language": null,
        "isPrimaryContact": false,
        "aboutMe": "Demo content",
        "title": "Manager"
    },
    {
        "id": 23456,
        "accountAccess": [
            "Employee",
            "Channel Manager"
        ],
        "businessRole": [
            "Marketing",
            "Sales"
        ],
        "firstName": "Jeff",
        "lastName": "Brown",
        "email": "jeff.brown@domain.com",
        "location": "Chicago",
        "territory": "Territory 2",
        "phone": "874-987-4536",
        "phoneExt": "352",
        "language": null,
        "isPrimaryContact": false,
        "aboutMe": "Hello, I am Jeff.",
        "title": "Manager"
    }
]

GET details for a single Brand contact

This endpoint will retrieve the details for a single brand user contact.

 

Endpoint /api/v1.0/branduser/{id}
Method GET
Request Headers Content-Type : application/json
Request Body N/A

Response Body Sample

  
[
    {
 "digitalProfilePicture": "",
    "id": 12345,
    "accountAccess": [
        "Channel Manager",
        "Agency"
    ],
    "businessRole": [
        "Marketing",
        "Sales"
    ],
    "firstName": "James",
    "lastName": "Smith",
    "email": "james.smith@domain.com",
    "location": "Atlanta",
    "territory": "Territory 1",
    "phone": "870-345-4534",
    "phoneExt": "123",
    "language": null,
    "isPrimaryContact": false,
    "aboutMe": "Demo content",
    "title": "Manager"
}
]