API & Automations

comment

The Credit Repair Cloud Developer API is designed for experienced web developers proficient in XML. If you are new to REST, you can learn basics at http://en.wikipedia.org/wiki/REST or look at options for Zapier

Examples

1. Insert Record (Lead/Client)

Important: Use the POST method to pass these parameters instead of GET method.

You have to pass the xmlData as a POST parameter.

API Method: insertRecord

XML Format:

https://app.creditrepaircloud.com/api/lead/insertRecord?apiauthkey=yourapikey&secretkey=yoursecretkey&xmlData=yourxmldata

XML Data:

XMLDATA sample:

Request Parameters

Parameter
Data Type
Description
apiauthkey *
String
Encrypted alphanumeric string to authenticate your Credit repair cloud credentials.
secretkey *
String
Encrypted alphanumeric string to authenticate your Credit repair cloud credentials.
xmlData *
String
This is an XML string and the format should be in XML format.
type *
String

Client status type should be in string format as per below.

Client
Lead
Lead/Inactive
Inactive
Suspended

Note: To add your own custom status. pls login and go to
https://app.creditrepaircloud.com/mycompany/clientstatus
and Copy status name in xml

firstname *
String
First name should be in string format.
lastname *
String
Last name should be in string format.
middlename
String
Middle name should be in string format.
suffix
String
Suffix should be in string format.
email
Email
Email should be in email format.
phone_home
Integer
Home Phone should be in 10 digit number format.
phone_work
Integer
Work Phone should be in 10 digit number format.
phone_mobile
Integer
Mobile Phone format should be in (999) 999-9999
street_address
String
Street Address should be in string format.
city
String
City should be in string format.
state
String
State should be in string format.
post_code
Integer
Post code should be in number format.
ssno
Integer
Social Security no.should be in 4 digit number format.
birth_date
Date
Birth date should be in in mm/dd/yyyy format.
memo
String
Memo should be in string format.
previous_mailing_address
String
Previous mailing address should be in string format. Previous mailing address (only if at current mailing address for less than 2 years)
previous_city
String
Previous City should be in string format.
previous_state
String
Previous State should be in string format.
previous_zip
Integer
Previous zip should be in number format.
client_assigned_to
String
Name of team members with comma separator for assing team members to client.
Note: Pls login and go to
https://app.creditrepaircloud.com/mycompany/team
and Copy team member name in xml
client_portal_access
On or Off
Portal Access for client. Values should be on or off
https://secureclientaccess.com
on = Client can access portal
off = Client can not access portal
client_userid
Email
Userid same as email
Note: Only accepted if client_portal_access is on
client_agreement
String
Agreement name should be in alphanumeric string
Note: Pls login and go to https://app.creditrepaircloud.com/mycompany/agreement and Copy agreement name in xml
Note: Only accepted if client_portal_access is on
send_setup_password_info_via_email
Yes or No
yes = System will send login information via email and instructions for setting password to client.
no = System will not send login information via email and instructions for setting password to client.
Note: Only accepted if client_portal_access is on
referred_by_firstname
String
Referred by first name should be in string format.
referred_by_lastname
String
Referred by last name should be in string format.
referred_by_email
Email
Email should be in email format.

* - Mandatory parameter

2. Update Record (Lead/Client)

Important: Use the POST method to pass these parameters instead of GET method.

You have to pass the xmlData as a POST parameter.

API Method: updateRecord

XML Format:

https://app.creditrepaircloud.com/api/lead/updateRecord?apiauthkey=yourapikey&secretkey=yoursecretkey&xmlData=yourxmldata

XML Data:

XMLDATA sample:

Request Parameters

Parameter
Data Type
Description
apiauthkey *
String
Encrypted alphanumeric string to authenticate your Credit repair cloud credentials.
secretkey *
String
Encrypted alphanumeric string to authenticate your Credit repair cloud credentials.
xmlData *
String
This is an XML string and the format should be in XML format.
type *
String

Client status type should be in string format as per below.

Client
Lead
Lead/Inactive
Inactive
Suspended

Note: To add your own custom status. pls login and go to
https://app.creditrepaircloud.com/mycompany/clientstatus
and Copy status name in xml

firstname *
String
First name should be in string format.
lastname *
String
Last name should be in string format.
middlename
String
Middle name should be in string format.
suffix
String
Suffix should be in string format.
email
Email
Email should be in email format.
phone_home
Integer
Home Phone should be in 10 digit number format.
phone_work
Integer
Work Phone should be in 10 digit number format.
phone_mobile
Integer
Mobile Phone format should be in (999) 999-9999
street_address
String
Street Address should be in string format.
city
String
City should be in string format.
state
String
State should be in string format.
post_code
Integer
Post code should be in number format.
ssno
Integer
Social Security no.should be in 4 digit number format.
birth_date
Date
Birth date should be in in mm/dd/yyyy format.
memo
String
Memo should be in string format.
previous_mailing_address
String
Previous mailing address should be in string format. Previous mailing address (only if at current mailing address for less than 2 years)
previous_city
String
Previous City should be in string format.
previous_state
String
State should be in string format.
previous_zip
Integer
Previous zip should be in number format.
client_assigned_to
String
Name of team members with comma separator for assing team members to client.
Note: Pls login and go to
https://app.creditrepaircloud.com/mycompany/team
and Copy team member name in xml
referred_by_firstname
String
Referred by first name should be in string format.
referred_by_lastname
String
Referred by last name should be in string format.
referred_by_email
Email
Email should be in email format.

* - Mandatory parameter

3. Delete Record (Lead/Client)

Important: Use the POST method to pass these parameters instead of GET method.

You have to pass the xmlData as a POST parameter.

API Method: deleteRecord

XML Format:

https://app.creditrepaircloud.com/api/lead/deleteRecord?apiauthkey=yourapikey&secretkey=yoursecretkey&xmlData=yourxmldata

XML Data:

XMLDATA sample:

Request Parameters

Parameter
Data Type
Description
apiauthkey *
String
Encrypted alphanumeric string to authenticate your Credit repair cloud credentials.
secretkey *
String
Encrypted alphanumeric string to authenticate your Credit repair cloud credentials.
xmlData *
String
This is an XML string and the format should be in XML format.
id *
String
Encrypted alphanumeric string.

* - Mandatory parameter

4. View Record (Lead/Client)

Important: Use the POST method to pass these parameters instead of GET method.

You have to pass the xmlData as a POST parameter.

API Method: viewRecord

XML Format:

https://app.creditrepaircloud.com/api/lead/viewRecord?apiauthkey=yourapikey&secretkey=yoursecretkey&xmlData=yourxmldata

XML Data:

XMLDATA sample:

Request Parameters

Parameter
Data Type
Description
apiauthkey *
String
Encrypted alphanumeric string to authenticate your Credit repair cloud credentials.
secretkey *
String
Encrypted alphanumeric string to authenticate your Credit repair cloud credentials.
xmlData *
String
This is an XML string and the format should be in XML format.
id *
String
Encrypted alphanumeric string.

* - Mandatory parameter

1. Insert Record (Affiliate)

Important: Use the POST method to pass these parameters instead of GET method.

You have to pass the xmlData as a POST parameter.

API Method: insertRecord

XML Format:

https://app.creditrepaircloud.com/api/affiliate/insertRecord?apiauthkey=yourapikey&secretkey=yoursecretkey&xmlData=yourxmldata

XML Data:

XMLDATA sample:

Request Parameters

Parameter
Data Type
Description
apiauthkey *
String
Encrypted alphanumeric string to authenticate your Credit repair cloud credentials.
secretkey *
String
Encrypted alphanumeric string to authenticate your Credit repair cloud credentials.
xmlData *
String
This is an XML string and the format should be in XML format.
type *
String

Affiliate status type should be in string format as per below.

Active
Inactive
Pending

firstname *
String
First name should be in string format.
lastname *
String
Last name should be in string format.
gender
String
Gender should be Male or Female.
company
String
Company name should be in string format.
company_url
String
Company URL should be in url format.
email *
Email
Email should be in email format.
phone *
Integer
Phone should be in 10 digit number format.
phone_ext
Integer
Phone extension should be upto 10 digit number format.
alternate_phone
Integer
Alternate phone should be in 10 digit number format.
mailing_address
String
Street Address should be in string format.
city
String
City should be in string format.
state
String
State should be in string format.
zip
Integer
Zip should be in number format.
internal_note
String
Internal note should be in string format.
affiliate_portal_access
On or Off
Portal Access for affiliate. Values should be on or off
https://secureclientaccess.com
on = Affiliate can access portal
off = Affiliate can not access portal
affiliate_userid
Email
Userid same as email
Note: Only accepted if affiliate_portal_access is on
send_setup_password_info_via_email
yes or no
yes = System will send login information via email and instructions for setting password to affiliate.
no = System will not send login information via email and instructions for setting password to affiliate.
Note: Only accepted if affiliate_portal_access is on

* - Mandatory parameter

2. Update Record (Affiliate)

Important: Use the POST method to pass these parameters instead of GET method.

You have to pass the xmlData as a POST parameter.

API Method: updateRecord

XML Format:

https://app.creditrepaircloud.com/api/affiliate/updateRecord?apiauthkey=yourapikey&secretkey=yoursecretkey&xmlData=yourxmldata

XML Data:

XMLDATA sample:

Request Parameters

Parameter
Data Type
Description
apiauthkey *
String
Encrypted alphanumeric string to authenticate your Credit repair cloud credentials.
secretkey *
String
Encrypted alphanumeric string to authenticate your Credit repair cloud credentials.
xmlData *
String
This is an XML string and the format should be in XML format.
type *
String

Affiliate status type should be in string format as per below.

Active
Inactive
Pending

firstname *
String
First name should be in string format.
lastname *
String
Last name should be in string format.
gender
String
Gender should be Male or Female.
company
String
Company name should be in string format.
company_url
String
Company URL should be in url format.
email *
Email
Email should be in email format.
phone *
Integer
Phone should be in 10 digit number format.
phone_ext
Integer
Phone extension should be upto 10 digit number format.
alternate_phone
Integer
Alternate phone should be in 10 digit number format.
mailing_address
String
Street Address should be in string format.
city
String
City should be in string format.
state
String
State should be in string format.
post_code
Integer
Post code should be in number format.
internal_note
String
Internal note should be in string format.

* - Mandatory parameter

3. Delete Record (Affiliate)

Important: Use the POST method to pass these parameters instead of GET method.

You have to pass the xmlData as a POST parameter.

API Method: deleteRecord

XML Format:

https://app.creditrepaircloud.com/api/affiliate/deleteRecord?apiauthkey=yourapikey&secretkey=yoursecretkey&xmlData=yourxmldata

XML Data:

XMLDATA sample:

Request Parameters

Parameter
Data Type
Description
apiauthkey *
String
Encrypted alphanumeric string to authenticate your Credit repair cloud credentials.
secretkey *
String
Encrypted alphanumeric string to authenticate your Credit repair cloud credentials.
xmlData *
String
This is an XML string and the format should be in XML format.
id *
String
Encrypted alphanumeric string.

* - Mandatory parameter

4. View Record (Affiliate)

Important: Use the POST method to pass these parameters instead of GET method.

You have to pass the xmlData as a POST parameter.

API Method: viewRecord

XML Format:

https://app.creditrepaircloud.com/api/affiliate/viewRecord?apiauthkey=yourapikey&secretkey=yoursecretkey&xmlData=yourxmldata

XML Data:

XMLDATA sample:

Request Parameters

Parameter
Data Type
Description
apiauthkey *
String
Encrypted alphanumeric string to authenticate your Credit repair cloud credentials.
secretkey *
String
Encrypted alphanumeric string to authenticate your Credit repair cloud credentials.
xmlData *
String
This is an XML string and the format should be in XML format.
id *
String
Encrypted alphanumeric string.

* - Mandatory parameter