Insert a Contact

POST /contacts/ — Use this method to create a new contact record.

Parameters

Path parameters

None

Query string parameter

Path parameter	Required / Optional	Description	Type
`fields`	Optional	A comma-separated list of attributes to include in the response. If not specified, the response includes all attributes for the contact returned.	string
`filterSetId`	Optional	The internal ID of the filter set to be applied. When specified, the request is successful only if the action is available when the specified filter set is active in SuiteProjects Pro. The filter set with the specified internal ID must exist and must be associated with the user who authorized the application as per the access token. Otherwise and by default, the primary filter set associated with the user who authorized the application is applied.	integer
`return_object`	Optional	If set to 1, the response will return the contact created. Otherwise, the response will include only the internal ID of the contact created.	Boolean

Path parameter

Required / Optional

Description

Type

fields

Optional

A comma-separated list of attributes to include in the response. If not specified, the response includes all attributes for the contact returned.

string

filterSetId

Optional

The internal ID of the filter set to be applied.

When specified, the request is successful only if the action is available when the specified filter set is active in SuiteProjects Pro. The filter set with the specified internal ID must exist and must be associated with the user who authorized the application as per the access token.
Otherwise and by default, the primary filter set associated with the user who authorized the application is applied.

integer

return_object

Optional

If set to 1, the response will return the contact created. Otherwise, the response will include only the internal ID of the contact created.

Boolean

Request body

The Contact object to be created. The object must include valid key-value pairs for all required attributes and cannot include key-value pairs for read-only attributes. For information about the Contact object model, see Contact object properties.

Response definitions

A successful request returns a JSON object with the following properties:

Property	Description
`data`	An array containing one of the following: The `Contact` object created, if the `return_object` parameter was set to any value other than `0` (zero) in the request. The object includes all the attributes specified using the `fields` if included in the request. An object with only the internal ID of the contact created. See Returned Data.
`message`	A string containing a brief message about the status of your request — for example, `“Success”`.

Property

Description

data

An array containing one of the following:

The Contact object created, if the return_object parameter was set to any value other than 0 (zero) in the request. The object includes all the attributes specified using the fields if included in the request.
An object with only the internal ID of the contact created.

See Returned Data.

message

A string containing a brief message about the status of your request — for example, “Success”.

A failed request returns a JSON object with the following properties:

Property	Description
`message`	A string containing a brief message about the status of your request.

Property

Description

message

A string containing a brief message about the status of your request.

Sample request

            POST /rest/v1/contacts/ HTTP/1.1
Host: company-id.app.netsuitesuiteprojectspro.com
Content-Type: application/json
Authorization: Bearer <OAuth2_access_token>

{
   "jobTitle": "Head of Finance",
   "email": "jdoe@example.com",
   "lastName": "Doe",
   "firstName": "John",
   "nickname": "J. Doe",
   "isActive": true,
   "customerId": 68,
}

In the example, <OAuth2_access_token> is the OAuth 2.0 access token obtained for the client application connecting to SuiteProjects Pro. See Authentication.

Sample response

            {
   "data": [
      {
         "id": 24
      }
   ],
   "message": "success"
}