SugarCRM SupportProduct GuidesSugar DeveloperSugar Developer Guide 9.2IntegrationWeb ServicesREST APIEndpoints/<module> POST
This release is only available for SugarCloud customers.

/<module> POST

Overview

Create a new record of a specified type.

Request Arguments

Name Type Description Required
<record field> <record field type> The name value list of fields to populate. True

Request

{
    "name":"Example Account",
    "account_type":"Customer",
    "description":"My Example Account",
    "meetings": {
    {
        "add": ["21e3385e-404f-b470-407e-54044e3d8023"],
        "create": [
        {
            "name": "Test Meeting"
        }
      ]
    }
  }
}
It is possible to add record relations to other records and create new related records.
Action Type Description
add List List of related records ID. See RelateRecordApi for details.
create List List of name to value arrays of related records.

Response Arguments

Name Type Description
<record field> <record field type> Returns the fields for the newly created record.

Response

{
   "id":"e91b1fa7-1bd8-3c71-be96-512e643f9ca4",
   "name":"Example Account",
   "date_entered":"2013-02-27T19:56:00+00:00",
   "date_modified":"2013-02-27T19:56:00+00:00",
   "modified_user_id":"1",
   "modified_by_name":"Administrator",
   "created_by":"1",
   "created_by_name":"Administrator",
   "description":"My Example Account",
   "img":"",
   "deleted":false,
   "assigned_user_id":"",
   "assigned_user_name":"",
   "team_name":[
      {
         "id":1,
         "name":"Global",
         "name_2":"",
         "primary":true
      }
   ],
   "linkedin":"",
   "facebook":"",
   "twitter":"",
   "googleplus":"",
   "account_type":"Customer",
   "industry":"",
   "annual_revenue":"",
   "phone_fax":"",
   "billing_address_street":"",
   "billing_address_street_2":"",
   "billing_address_street_3":"",
   "billing_address_street_4":"",
   "billing_address_city":"",
   "billing_address_state":"",
   "billing_address_postalcode":"",
   "billing_address_country":"",
   "rating":"",
   "phone_office":"",
   "phone_alternate":"",
   "website":"",
   "ownership":"",
   "employees":"",
   "ticker_symbol":"",
   "shipping_address_street":"",
   "shipping_address_street_2":"",
   "shipping_address_street_3":"",
   "shipping_address_street_4":"",
   "shipping_address_city":"",
   "shipping_address_state":"",
   "shipping_address_postalcode":"",
   "shipping_address_country":"",
   "email1":"",
   "parent_id":"",
   "sic_code":"",
   "parent_name":"",
   "email_opt_out":"",
   "invalid_email":"",
   "email":[

   ],
   "campaign_id":"",
   "campaign_name":"",
   "my_favorite":false,
   "_acl":{
      "fields":{

      }
   }
}

Change Log

Version Change
v10 (7.6.0) Added support for link fields.
v10 Added /<module> POST endpoint.

Last modified: 2019-10-03 21:35:41