Examples

Example - create Deal

Creates a ”deal” as main object

Sets the name of the deal to ”Ny affär” (“New deal”) (usually mandatory)

{
  "object": {
    "lime_object_name": "deal",
    "create_object": {
      "name": "Ny affär"
    }
  }
}

Example - create History

Creates a "history" as main object

Puts all the formdata in the field "note" on history object

Sets the history "type" to the value "comment" (usually mandatory)

{
  "object": {
    "lime_object_name": "history",
    "summary_field": "note",
    "create_object": {
      "type": "comment"
    }
  }
}

Example - create Document

Creates a ”document” as main object

Sets the document "type" to the value "other" (usually mandatory)

{
  "object": {
    "lime_object_name": "document",
    "create_object": {
      "type": "other"
    }
  }
}

Example – create Deal and Document

Creates a ”deal” as main object

Sets the name of the deal to ”Ny affär” (“New deal”) (usually mandatory)

Creates a document related to the deal, IF document(s) or file was uploaded in the form

Sets the document "type" to the value "other" (usually mandatory)

{
  "object": {
    "lime_object_name": "deal",
    "create_object": {
      "name": "Ny affär"
    }
  },
  "document": {
    "lime_object_name": "document",
    "object_relation": "deal",
    "create_object": {
      "type": "other"
    }
  }
}

Example – create Deal and History

Creates a ”deal” as main object

Sets the name of the deal to ”Ny affär” (“New deal”) (usually mandatory)

Creates a history related to the deal

Puts all the formdata in the field "note" on history object

Sets the history "type" to the value "comment" (usually mandatory)

{
  "object": {
    "lime_object_name": "deal",
    "create_object": {
      "name": "Ny affär"
    }
  },
  "history": {
    "lime_object_name": "history",
    "object_relation": "deal",
    "summary_field": "note",
    "create_object": {  
      "type": "comment"
    }
  }
}

Example – create Deal and History with BankID information

Creates a ”deal” as main object

Sets the name of the deal to ”Ny affär” (“New deal”) (usually mandatory)

Creates a history related to the deal

Puts all the formdata in the field "note" on history object

Sets the history "type" to the value "comment" (usually mandatory)

Adds (appends) BankID label and BankID URL to the history note field

{
  "object": {
    "lime_object_name": "deal",
    "create_object": {
      "name": "Ny affär"
    }
  },
  "history": {
    "lime_object_name": "history",
    "object_relation": "deal",
    "summary_field": "note",
    "create_object": {  
      "type": "comment"
    },
  "bankid": {
    "label": "Signed using BankID",
    "field": "note"
    }
  }
}

Example – create Deal with BankID URL in separate field

Creates a ”deal” as main object

Sets the name of the deal to ”Ny affär” (“New deal”)(usually mandatory)

Adds BankID URL to the field “bankid_signature”

{
  "object": {
    "lime_object_name": "deal",
    "create_object": {
      "name": "Ny affär"
      },
    "bankid": {
      "field": "bankid_signature"
    }
  }
}

Example – create Deal, Document and History

Creates a ”deal” as main object

Sets the name of the deal to ”Ny affär” (“New deal”) (usually mandatory)

Creates a document related to the deal, IF document(s) was uploaded in the form

Sets the document "type" to the value "other" (usually mandatory)

Creates a history related to the deal

Puts all the formdata in the field "note" on history object

Sets the history "type" to the value "comment" (usually mandatory)

{
  "object": {
    "lime_object_name": "deal",
    "create_object": {
      "name": "Ny affär"
    }
  },
  "document": {
    "lime_object_name": "document",
    "object_relation": "deal",
    "create_object": {
      "type": "other"
    }
  },
  "history": {
    "lime_object_name": "history",
    "object_relation": "deal",
    "summary_field": "note",
    "create_object": {  
      "type": "comment"
    }
  }
}

Example – create Deal, Document, History and search Person

Creates a ”deal” as main object

Sets the name of the deal to ”Ny affär” (“New deal”) (usually mandatory)

Creates a document related to the deal, IF document(s) was uploaded in the form

Sets the document "type" to the value "other" (usually mandatory)

Creates a history related to the deal

Puts all the formdata in the field "note" on history object

Sets the history "type" to the value "comment" (usually mandatory)

Searches for person by using the Forms field “person_email” and tries to find that value in Lime on the field “email” on the person object. If found, person (and the company the person is related to) will be related to the created deal

{
  "object": {
    "lime_object_name": "deal",
    "person_relation": "person",
    "company_relation": "company",
    "create_object": {
      "name": "Ny affär"
    }
  },
  "person": {
    "lime_object_name": "person",
    "lime_search_parameter": "email",
    "forms_search_parameter": "forms_person_email",
    "company_relation": "company"
  },
  "document": {
    "lime_object_name": "document",
    "object_relation": "deal",
    "create_object": {
      "type": "other"
    }
  },
  "history": {
    "lime_object_name": "history",
    "object_relation": "deal",
    "summary_field": "note",
    "create_object": {  
      "type": "comment"
    }
  }
}

Example - create Deal, Document, History and search/create Person

Creates a ”deal” as main object

Sets the name of the deal to ”Ny affär” (“New deal”) (usually mandatory)

Creates a document related to the deal, IF document(s) was uploaded in the form

Sets the document "type" to the value "other" (usually mandatory)

Creates a history related to the deal

Puts all the formdata in the field "note" on history object

Sets the history "type" to the value "comment" (usually mandatory)

Searches for person by using the Forms field “person_email” and tries to find that value in Lime on the field “email” on the person object. If found, person (and the company the person is related to) will be related to the created deal.

Create person if not found, by using supplied data from the form. The created person will be related to the created deal.

{
  "object": {
    "lime_object_name": "deal",
    "person_relation": "person",
    "company_relation": "company",
    "create_object": {
      "name": "Ny affär"
    }
  },
  "person": {
    "lime_object_name": "person",
    "lime_search_parameter": "email",
    "forms_search_parameter": "forms_person_email",
    "company_relation": "company",
    "create_object": {
      "firstname": "forms_person_firstname",
      "lastname": "forms_person_lastname",
      "mobilephone": "forms_person_mobile",
      "email": "forms_person_email"
    }
  },
  "document": {
    "lime_object_name": "document",
    "object_relation": "deal",
    "create_object": {
      "type": "other"
    }
  },
  "history": {
    "lime_object_name": "history",
    "object_relation": "deal",
    "summary_field": "note",
    "create_object": {  
      "type": "comment"
    }
  }
}

Example - create Deal, Document, History, search/create Person and create Company

Creates a ”deal” as main object

Sets the name of the deal to ”Ny affär” (“New deal”) (usually mandatory)

Creates a document related to the deal, IF document(s) was uploaded in the form

Sets the document "type" to the value "other" (usually mandatory)

Creates a history related to the deal

Puts all the formdata in the field "note" on history object

Sets the history "type" to the value "comment" (usually mandatory)

Searches for person by using the Forms field “person_email” and tries to find that value in Lime on the field “email” on the person object. If found, person (and the company the person is related to) will be related to the created deal.

Create person if not found, by using supplied data from the form. The created person will be related to the created deal.

Create company if person was created, by using supplied data from the form. The person will be related to the created company. Person and company will be related to the created deal.

Adds person and company relations to created history and documents, by setting person_relation and company_relation.

{
  "object": {
    "lime_object_name": "deal",
    "person_relation": "person",
    "company_relation": "company",
    "create_object": {
      "name": "Ny affär"
    }
  },
  "person": {
    "lime_object_name": "person",
    "lime_search_parameter": "email",
    "forms_search_parameter": "forms_person_email",
    "company_relation": "company",
    "create_object": {
      "firstname": "forms_person_firstname",
      "lastname": "forms_person_lastname",
      "mobilephone": "forms_person_mobile",
      "email": "forms_person_email"
    }
  },
  "company": {
    "lime_object_name": "company",
    "create_object": {
      "name": "forms_company_name",
      "phone": "forms_person_mobile",
      "email": "forms_person_email"
    }
  },
  "document": {
    "lime_object_name": "document",
    "object_relation": "deal",
    "person_relation": "person",
    "company_relation": "company",
    "create_object": {
      "type": "other"
    }
  },
  "history": {
    "lime_object_name": "history",
    "object_relation": "deal",
    "person_relation": "person",
    "company_relation": "company",
    "summary_field": "note",
    "create_object": {  
      "type": "comment"
    }
  }
}