Lead Gen & CRM
How can we help you?
Search our help articles, video tutorials, and quickstart guides

You've got this. You've got us. Search our Knowledge Base to quickly find answers to your questions.

Understanding Lead Gen & CRM Open API Methods: Agency Data

Article: 000050892
Updated: July 9, 2024

A reference source for Lead Gen & CRM's Agency Data-specific API methods

Lead Gen & CRM has a distinct API organization. This article will detail the methods listed within the Lead Gen & CRM API, related to Agencies.


Article Contents


Users:
Administrators 
Company Managers  
Marketing Managers  
Sales Managers  
Salespersons  
Jr. Salespersons  

 

Additional API Information

This article provides specific method content about Lead Gen & CRM's API. However, given the size and scope of the API, information is broken up and is contained in different articles. Each article focuses on a specific function of Lead Gen & CRM's API. Additional API information can be found in the following articles:


 

Company Profile Managed By

getClients

Gets a list of all active companies managed by your company.
 
Params Name Type  Is Required  

None listed

       
Return
Data
Name Type    
getAllcompanyProfileManagedBys 

list<Client>

 

 


 

accountSendLimit
 

updateAccountSendLimit

Updates the send limit of a subaccount.
 
Params Name Type  Is Required  

clientID

 int Required 

emailLimit

 int  Required  
       
Return
Data
Name Type    

updates

 list<UpdateResult> 

 



companyProfile
 

createClient

Creates a subclient for agencies.

country:    This value is based on ISO 3166-1 alpha-2
                   standard. Examples include US, UK, and IT.

locale:       Optional. This value is responsible for your
                   language and needs to be one of the following:
 
                       •   en_US
                    •   de_DE
                    •   es_ES 
                    •   fr_FR 
                    •   it_IT
 
 •   nl_NL 
•   pt_PT
•   ro_RO
•   sk_SK
•   tr_TR
 
 
   salesStartHour:    Based on a 24-hour clock. 00h to 24h.
salesEndHour:      Based on a 24-hour clock. 00h to 24h.

Adding a username and password will create a new user for that profile.
 
Params Name Type  Is Required  

companyName

 string  Required 

streetAddress

 string  Optional 

zipCode

 string  Optional  

country

 string  Optional  

state

 string  Optional  

city

 string  Optional  

salesPhone

 string  Required 

defaultCurrency

 string Optional  

locale

 string Optional  

salesStartHour

 int Optional  

salesEndHour

 int Optional  

salesOfficialTimeZone

 string Optional  

disallowClientRebrand

 boolean Optional  

hideGoogleAdWords

 boolean Optional  

displayCallTrackingSettings

 boolean Optional  

userEmail

 string Optional  

userPassword

 string  Optional  

userDisplayName

 string  Optional  
       
Return
Data
Name Type    

status

 boolean 

error

 array 

userID

 int    

id

 int    

 



companyProfileUpdate
 

updateClient

Updates a subclient for agencies.

country:    This value is based on ISO 3166-1 alpha-2
                   standard. Examples include US, UK, and IT.

locale:       Optional. This value is responsible for your
                   language and needs to be one of the following:
 
                       •   en_US
                    •   de_DE
                    •   es_ES 
                    •   fr_FR 
                    •   it_IT
 
 •   nl_NL 
•   pt_PT
•   ro_RO
•   sk_SK
•   tr_TR
 
 
   salesStartHour:    Based on a 24-hour clock. 00h to 24h.
salesEndHour:      Based on a 24-hour clock. 00h to 24h.
 
Params Name Type  Is Required  

id

 int Required 

streetAddress

 string Optional 

zipCode

 string Optional  

country

 string  Optional  

state

 string  Optional  

city

 string  Optional  

salesPhone

 string  Optional  

defaultCurrency

 string  Optional  

locale

 string  Optional  

salesStartHour

 int Optional  

salesEndHour

 int  Optional  

salesOfficialTimeZone

 string Optional  

disallowClientRebrand

 boolean Optional  

hideGoogleAdWords

 boolean  Optional  

displayCallTrackingSettings

 boolean  Optional  
       
Return
Data
Name Type    

updates

 list<UpdateResult> 

 



disableAccountSending
 

disableAccountSending

Disables a subaccount's sending.
 
Params Name Type  Is Required  

clientID

 int Required 
       
Return
Data
Name Type    

updates

 list<UpdateResult> 

 



enableAccountSending
 

enableAccountSending

Enables a subaccount's sending.
 
Params Name Type  Is Required  
clientID int 

Required

 
       
Return
Data
Name Type    
updates 

list<UpdateResult>

 

 

 


Did this article answer your question?


Constant Contact Logo

Copyright © 2025 · All Rights Reserved · Constant Contact · Privacy Center