AddContactLink
API Home ◂ Contact Functions ◂ Contact Links ◂ AddContactLink
Overview
Adds a new “Contact Link” to a contact based on information sent via an http form post.
Post Url
https://www.allclients.com/api/2/AddContactLink.aspx
SSL is requred
White Label CRM Customers: Replace www.allclients.com with your White Label CRM domain name.
Form Fields
Field | Max Length* | Required | Notes |
---|---|---|---|
response_type | No | Default results will be returned in XML. Set this field value to json to return results in JSON format. |
|
accountid | Yes | Must be numeric. Account ID for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel |
|
apikey | Yes | API Key for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel |
|
contactid | Yes | Contact ID | |
url | 255 | Yes | URL, must start with https:// or http:// |
label | 50 | Yes | Label or description of the link |
Field | Max Length* | Required | Notes |
---|---|---|---|
response_type | No | Default results will be returned in XML. Set this field value to json to return results in JSON format. |
|
accountid | Yes | Must be numeric. Account ID for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel. |
|
apikey | Yes | API Key for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel. |
|
contactid | Yes | Contact ID | |
url | 255 | Yes | URL, must start with https:// or http:// |
label | 50 | Yes | Label or description of the link |
Field | Max Length* | Required | Notes |
---|---|---|---|
response_type | No | Default results will be returned in XML. Set this field value to json to return results in JSON format. |
|
accountid | Yes | Must be numeric. Account ID for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel. |
|
apikey | Yes | API Key for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel. |
|
contactid | Yes | Contact ID | |
url | 255 | Yes | URL, must start with https:// or http:// |
label | 50 | Yes | Label or description of the link |
Sample Results
Sample Success Message
<?xml version="1.0"?> <results> <message>Success</message> <sourceid>15631</sourceid> </results>
Sample Failure Message
<?xml version="1.0"?> <results> <error>Authentication failed</error> </results> <?xml version="1.0"?> <results> <error>Flag with this 'name' already exists</error> </results>