Generate Lead

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Appointment/GenerateLead");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"AssociateIdForNewContact\": 123,\n  \"LeadDescription\": \"<string>\",\n  \"Relation\": \"<string>\",\n  \"RelationId\": 123,\n  \"LeadContact\": \"<string>\",\n  \"LeadPersonFirstname\": \"<string>\",\n  \"LeadPersonLastname\": \"<string>\",\n  \"LeadPersonEmail\": \"<string>\",\n  \"LeadPhoneNumber\": \"<string>\",\n  \"CreatorsContact\": \"<string>\",\n  \"CreatorsFirstname\": \"<string>\",\n  \"CreatorsLastname\": \"<string>\"\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    AssociateIdForNewContact: 123,
    LeadDescription: '<string>',
    Relation: '<string>',
    RelationId: 123,
    LeadContact: '<string>',
    LeadPersonFirstname: '<string>',
    LeadPersonLastname: '<string>',
    LeadPersonEmail: '<string>',
    LeadPhoneNumber: '<string>',
    CreatorsContact: '<string>',
    CreatorsFirstname: '<string>',
    CreatorsLastname: '<string>'
  })
};

fetch('http://localhost:56350/api/v1/Agents/Appointment/GenerateLead', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Appointment/GenerateLead",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'AssociateIdForNewContact' => 123,
    'LeadDescription' => '<string>',
    'Relation' => '<string>',
    'RelationId' => 123,
    'LeadContact' => '<string>',
    'LeadPersonFirstname' => '<string>',
    'LeadPersonLastname' => '<string>',
    'LeadPersonEmail' => '<string>',
    'LeadPhoneNumber' => '<string>',
    'CreatorsContact' => '<string>',
    'CreatorsFirstname' => '<string>',
    'CreatorsLastname' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "http://localhost:56350/api/v1/Agents/Appointment/GenerateLead"

payload = {
    "AssociateIdForNewContact": 123,
    "LeadDescription": "<string>",
    "Relation": "<string>",
    "RelationId": 123,
    "LeadContact": "<string>",
    "LeadPersonFirstname": "<string>",
    "LeadPersonLastname": "<string>",
    "LeadPersonEmail": "<string>",
    "LeadPhoneNumber": "<string>",
    "CreatorsContact": "<string>",
    "CreatorsFirstname": "<string>",
    "CreatorsLastname": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    AssociateIdForNewContact: 123,
    LeadDescription: '<string>',
    Relation: '<string>',
    RelationId: 123,
    LeadContact: '<string>',
    LeadPersonFirstname: '<string>',
    LeadPersonLastname: '<string>',
    LeadPersonEmail: '<string>',
    LeadPhoneNumber: '<string>',
    CreatorsContact: '<string>',
    CreatorsFirstname: '<string>',
    CreatorsLastname: '<string>'
  })
};

fetch('http://localhost:56350/api/v1/Agents/Appointment/GenerateLead', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "RequestedContacts": [
    {
      "ContactId": 123,
      "Name": "<string>",
      "OrgNr": "<string>",
      "Department": "<string>",
      "URL": "<string>",
      "City": "<string>",
      "DirectPhone": "<string>",
      "AssociateId": 123,
      "CountryId": 123,
      "EmailAddress": "<string>",
      "Kananame": "<string>",
      "EmailAddressName": "<string>",
      "URLName": "<string>",
      "AssociateFullName": "<string>",
      "BusinessName": "<string>",
      "CategoryName": "<string>",
      "CountryName": "<string>",
      "Address": {
        "Wgs84Latitude": 123,
        "Wgs84Longitude": 123,
        "LocalizedAddress": [
          [
            {
              "Name": "<string>",
              "Value": "<string>",
              "Tooltip": "<string>",
              "Label": "<string>",
              "ValueLength": 123,
              "AddressType": "<string>",
              "TableRight": {
                "Mask": "<string>",
                "Reason": "<string>"
              },
              "FieldProperties": {}
            }
          ]
        ],
        "Street": {
          "AtypeIdx": "Unknown",
          "Address1": "<string>",
          "Address2": "<string>",
          "Address3": "<string>",
          "City": "<string>",
          "County": "<string>",
          "State": "<string>",
          "Zipcode": "<string>",
          "Formatted": "<string>"
        },
        "Postal": {
          "AtypeIdx": "Unknown",
          "Address1": "<string>",
          "Address2": "<string>",
          "Address3": "<string>",
          "City": "<string>",
          "County": "<string>",
          "State": "<string>",
          "Zipcode": "<string>",
          "Formatted": "<string>"
        },
        "Formatted": "<string>",
        "TableRight": {
          "Mask": "<string>",
          "Reason": "<string>"
        },
        "FieldProperties": {}
      },
      "FormattedAddress": "<string>",
      "FullName": "<string>",
      "IsOwnerContact": true,
      "ActiveErpLinks": 123,
      "Number1": "<string>",
      "Number2": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "RequestedPerson": {
    "Position": "<string>",
    "PersonId": 123,
    "Mrmrs": "<string>",
    "Firstname": "<string>",
    "Lastname": "<string>",
    "MiddleName": "<string>",
    "Title": "<string>",
    "Description": "<string>",
    "Email": "<string>",
    "FullName": "<string>",
    "DirectPhone": "<string>",
    "FormalName": "<string>",
    "CountryId": 123,
    "ContactId": 123,
    "ContactName": "<string>",
    "Retired": 123,
    "Rank": 123,
    "ActiveInterests": 123,
    "ContactDepartment": "<string>",
    "ContactCountryId": 123,
    "ContactOrgNr": "<string>",
    "FaxPhone": "<string>",
    "MobilePhone": "<string>",
    "ContactPhone": "<string>",
    "AssociateName": "<string>",
    "AssociateId": 123,
    "UsePersonAddress": true,
    "ContactFax": "<string>",
    "Kanafname": "<string>",
    "Kanalname": "<string>",
    "Post1": "<string>",
    "Post2": "<string>",
    "Post3": "<string>",
    "EmailName": "<string>",
    "ContactFullName": "<string>",
    "ActiveErpLinks": 123,
    "TicketPriorityId": 123,
    "SupportLanguageId": 123,
    "SupportAssociateId": 123,
    "CategoryName": "<string>",
    "PersonNumber": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "SalesRep": {
    "Position": "<string>",
    "PersonId": 123,
    "Mrmrs": "<string>",
    "Firstname": "<string>",
    "Lastname": "<string>",
    "MiddleName": "<string>",
    "Title": "<string>",
    "Description": "<string>",
    "Email": "<string>",
    "FullName": "<string>",
    "DirectPhone": "<string>",
    "FormalName": "<string>",
    "CountryId": 123,
    "ContactId": 123,
    "ContactName": "<string>",
    "Retired": 123,
    "Rank": 123,
    "ActiveInterests": 123,
    "ContactDepartment": "<string>",
    "ContactCountryId": 123,
    "ContactOrgNr": "<string>",
    "FaxPhone": "<string>",
    "MobilePhone": "<string>",
    "ContactPhone": "<string>",
    "AssociateName": "<string>",
    "AssociateId": 123,
    "UsePersonAddress": true,
    "ContactFax": "<string>",
    "Kanafname": "<string>",
    "Kanalname": "<string>",
    "Post1": "<string>",
    "Post2": "<string>",
    "Post3": "<string>",
    "EmailName": "<string>",
    "ContactFullName": "<string>",
    "ActiveErpLinks": 123,
    "TicketPriorityId": 123,
    "SupportLanguageId": 123,
    "SupportAssociateId": 123,
    "CategoryName": "<string>",
    "PersonNumber": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

Generate Lead

Adds a sales lead (task) to a contact in SuperOffice.

If the contact or person is known, the sales lead is added to the current contact. If not, a new contact is created, with the associate with ownerIdForNewContact as responsible (Our Contact). A relation is created between the contact and the person submitting the lead. Based on wether the person the request is made for is found or not, the following happens: If the person is found, the person, person’s contact and sales representative is returned. If neither the person nor the contact is found a new person and contact is created (if sufficient data is supplied), and the person, person’s contact and sales representative is returned. If the contact and not the person is found a new person is created on this contact, and the contact, salesrep, and person is returned (if there was enough data to return the person). If more than one contact is found a list of contacts is returned. NsApiSlow threshold: 2000 ms.

Generate Lead

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Appointment/GenerateLead");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"AssociateIdForNewContact\": 123,\n  \"LeadDescription\": \"<string>\",\n  \"Relation\": \"<string>\",\n  \"RelationId\": 123,\n  \"LeadContact\": \"<string>\",\n  \"LeadPersonFirstname\": \"<string>\",\n  \"LeadPersonLastname\": \"<string>\",\n  \"LeadPersonEmail\": \"<string>\",\n  \"LeadPhoneNumber\": \"<string>\",\n  \"CreatorsContact\": \"<string>\",\n  \"CreatorsFirstname\": \"<string>\",\n  \"CreatorsLastname\": \"<string>\"\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    AssociateIdForNewContact: 123,
    LeadDescription: '<string>',
    Relation: '<string>',
    RelationId: 123,
    LeadContact: '<string>',
    LeadPersonFirstname: '<string>',
    LeadPersonLastname: '<string>',
    LeadPersonEmail: '<string>',
    LeadPhoneNumber: '<string>',
    CreatorsContact: '<string>',
    CreatorsFirstname: '<string>',
    CreatorsLastname: '<string>'
  })
};

fetch('http://localhost:56350/api/v1/Agents/Appointment/GenerateLead', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Appointment/GenerateLead",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'AssociateIdForNewContact' => 123,
    'LeadDescription' => '<string>',
    'Relation' => '<string>',
    'RelationId' => 123,
    'LeadContact' => '<string>',
    'LeadPersonFirstname' => '<string>',
    'LeadPersonLastname' => '<string>',
    'LeadPersonEmail' => '<string>',
    'LeadPhoneNumber' => '<string>',
    'CreatorsContact' => '<string>',
    'CreatorsFirstname' => '<string>',
    'CreatorsLastname' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "http://localhost:56350/api/v1/Agents/Appointment/GenerateLead"

payload = {
    "AssociateIdForNewContact": 123,
    "LeadDescription": "<string>",
    "Relation": "<string>",
    "RelationId": 123,
    "LeadContact": "<string>",
    "LeadPersonFirstname": "<string>",
    "LeadPersonLastname": "<string>",
    "LeadPersonEmail": "<string>",
    "LeadPhoneNumber": "<string>",
    "CreatorsContact": "<string>",
    "CreatorsFirstname": "<string>",
    "CreatorsLastname": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    AssociateIdForNewContact: 123,
    LeadDescription: '<string>',
    Relation: '<string>',
    RelationId: 123,
    LeadContact: '<string>',
    LeadPersonFirstname: '<string>',
    LeadPersonLastname: '<string>',
    LeadPersonEmail: '<string>',
    LeadPhoneNumber: '<string>',
    CreatorsContact: '<string>',
    CreatorsFirstname: '<string>',
    CreatorsLastname: '<string>'
  })
};

fetch('http://localhost:56350/api/v1/Agents/Appointment/GenerateLead', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "RequestedContacts": [
    {
      "ContactId": 123,
      "Name": "<string>",
      "OrgNr": "<string>",
      "Department": "<string>",
      "URL": "<string>",
      "City": "<string>",
      "DirectPhone": "<string>",
      "AssociateId": 123,
      "CountryId": 123,
      "EmailAddress": "<string>",
      "Kananame": "<string>",
      "EmailAddressName": "<string>",
      "URLName": "<string>",
      "AssociateFullName": "<string>",
      "BusinessName": "<string>",
      "CategoryName": "<string>",
      "CountryName": "<string>",
      "Address": {
        "Wgs84Latitude": 123,
        "Wgs84Longitude": 123,
        "LocalizedAddress": [
          [
            {
              "Name": "<string>",
              "Value": "<string>",
              "Tooltip": "<string>",
              "Label": "<string>",
              "ValueLength": 123,
              "AddressType": "<string>",
              "TableRight": {
                "Mask": "<string>",
                "Reason": "<string>"
              },
              "FieldProperties": {}
            }
          ]
        ],
        "Street": {
          "AtypeIdx": "Unknown",
          "Address1": "<string>",
          "Address2": "<string>",
          "Address3": "<string>",
          "City": "<string>",
          "County": "<string>",
          "State": "<string>",
          "Zipcode": "<string>",
          "Formatted": "<string>"
        },
        "Postal": {
          "AtypeIdx": "Unknown",
          "Address1": "<string>",
          "Address2": "<string>",
          "Address3": "<string>",
          "City": "<string>",
          "County": "<string>",
          "State": "<string>",
          "Zipcode": "<string>",
          "Formatted": "<string>"
        },
        "Formatted": "<string>",
        "TableRight": {
          "Mask": "<string>",
          "Reason": "<string>"
        },
        "FieldProperties": {}
      },
      "FormattedAddress": "<string>",
      "FullName": "<string>",
      "IsOwnerContact": true,
      "ActiveErpLinks": 123,
      "Number1": "<string>",
      "Number2": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "RequestedPerson": {
    "Position": "<string>",
    "PersonId": 123,
    "Mrmrs": "<string>",
    "Firstname": "<string>",
    "Lastname": "<string>",
    "MiddleName": "<string>",
    "Title": "<string>",
    "Description": "<string>",
    "Email": "<string>",
    "FullName": "<string>",
    "DirectPhone": "<string>",
    "FormalName": "<string>",
    "CountryId": 123,
    "ContactId": 123,
    "ContactName": "<string>",
    "Retired": 123,
    "Rank": 123,
    "ActiveInterests": 123,
    "ContactDepartment": "<string>",
    "ContactCountryId": 123,
    "ContactOrgNr": "<string>",
    "FaxPhone": "<string>",
    "MobilePhone": "<string>",
    "ContactPhone": "<string>",
    "AssociateName": "<string>",
    "AssociateId": 123,
    "UsePersonAddress": true,
    "ContactFax": "<string>",
    "Kanafname": "<string>",
    "Kanalname": "<string>",
    "Post1": "<string>",
    "Post2": "<string>",
    "Post3": "<string>",
    "EmailName": "<string>",
    "ContactFullName": "<string>",
    "ActiveErpLinks": 123,
    "TicketPriorityId": 123,
    "SupportLanguageId": 123,
    "SupportAssociateId": 123,
    "CategoryName": "<string>",
    "PersonNumber": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "SalesRep": {
    "Position": "<string>",
    "PersonId": 123,
    "Mrmrs": "<string>",
    "Firstname": "<string>",
    "Lastname": "<string>",
    "MiddleName": "<string>",
    "Title": "<string>",
    "Description": "<string>",
    "Email": "<string>",
    "FullName": "<string>",
    "DirectPhone": "<string>",
    "FormalName": "<string>",
    "CountryId": 123,
    "ContactId": 123,
    "ContactName": "<string>",
    "Retired": 123,
    "Rank": 123,
    "ActiveInterests": 123,
    "ContactDepartment": "<string>",
    "ContactCountryId": 123,
    "ContactOrgNr": "<string>",
    "FaxPhone": "<string>",
    "MobilePhone": "<string>",
    "ContactPhone": "<string>",
    "AssociateName": "<string>",
    "AssociateId": 123,
    "UsePersonAddress": true,
    "ContactFax": "<string>",
    "Kanafname": "<string>",
    "Kanalname": "<string>",
    "Post1": "<string>",
    "Post2": "<string>",
    "Post3": "<string>",
    "EmailName": "<string>",
    "ContactFullName": "<string>",
    "ActiveErpLinks": 123,
    "TicketPriorityId": 123,
    "SupportLanguageId": 123,
    "SupportAssociateId": 123,
    "CategoryName": "<string>",
    "PersonNumber": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

Headers

Accept-Language

string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language

string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture

string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone

string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken

string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$select

string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Body

AssociateIdForNewContact, LeadDescription, Relation, RelationId, LeadContact, LeadPersonFirstname, LeadPersonLastname, LeadPersonEmail, LeadPhoneNumber, CreatorsContact, CreatorsFirstname, CreatorsLastname

GenerateLead: Adds a sales lead (task) to a contact in SuperOffice. If the contact or person is known, the sales lead is added to the current contact. If not, a new contact is created, with the associate with ownerIdForNewContact as responsible (Our Contact). A relation is created between the contact and the person submitting the lead. Based on wether the person the request is made for is found or not, the following happens: If the person is found, the person, person's contact and sales representative is returned. If neither the person nor the contact is found a new person and contact is created (if sufficient data is supplied), and the person, person's contact and sales representative is returned. If the contact and not the person is found a new person is created on this contact, and the contact, salesrep, and person is returned (if there was enough data to return the person). If more than one contact is found a list of contacts is returned.

AssociateIdForNewContact

integer<int32>

LeadDescription

string

Relation

string

RelationId

integer<int32>

LeadContact

string

LeadPersonFirstname

string

LeadPersonLastname

string

LeadPersonEmail

string

LeadPhoneNumber

string

CreatorsContact

string

CreatorsFirstname

string

CreatorsLastname

string

Response

Carrier object for SalesActivity. Services for the SalesActivity Carrier is available from the Appointment Agent.

RequestedContacts

object[]

The companies that match the request

Show child attributes

RequestedPerson

object

Carrier object for Person. Services for the Person Carrier is available from the Person Agent.

Show child attributes

SalesRep

object

Carrier object for Person. Services for the Person Carrier is available from the Person Agent.

Show child attributes

TableRight

object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

Show child attributes

FieldProperties

object

Field property dictionary mapping field names to field access rights.

Show child attributes