Contacts / Entity
Create Contact
This endpoint allows you to create a Contact based on JSON input.
You will only be able to create a Contact after first providing the Session Key. To know how you can obtain the Session Key, go to Authentication.
HEADERS
| Parameter | Value | Description |
|---|---|---|
| Content-Type | application/json | Language in which all request and response bodies are encoded |
| Accept | */* | Any data of whatever mime type is accepted |
| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |
REQUEST BODY
| Attribute | Type | Description |
|---|---|---|
| accountId (Required) | Integer | Account to whom the Contact is linked to (see Accounts resource) |
| address1 | String | Contact's first address |
| city | String | City name |
| comment | String | Comment added to the Contact profile |
| countryId | Integer | Country ID (see Countries resource) of the address |
| String | Contact's email address | |
| email2 | String | Contact's second email address |
| email3 | String | Contact's third email address |
| extId | String | External ID of the Contact from a third party system (ERP, CRM, Accounting System) |
| fax | String | Contact's fax number |
| firstName (Required) | String | Contact's first name |
| gender | Integer | Male -> 0 or female -> 1 |
| lastName (Required) | String | Contact's last name |
| String | Contact's LinkedIn profile name | |
| permissionLevel | String | Defines the visibility of the Contact. Set from 1 to 5 being 5 the highest level of permission |
| phone1 | String | Contact's first phone number |
| phone2 | String | Contact's second phone number |
| postcode | String | Postcode of the Contact address |
| readOnly | boolean | If true, the Contact cannot be modified or deleted |
| region | String | Region/State name referred to the address |
| salesRepId (Required) | Object, Null | Contact responsible for the Contact |
| skype | String | Contact's Skype name |
| typeId | Integer | Contact Type (see Type resource) |
| UseCompanyAddress | Boolean | If true, Contact's address is the one of the associated Account |
| birthday | String | Contact's birthday |
| marketingCommunications | Boolean | If true, Contact can receive marketing communications |
RESPONSE
Returns a JSON with information about the Contact just created.
| Attribute | Type |
|---|---|
| Id | Id assigned to the new Contact |
| Message | The operation status |
RESPONSE CODES
| Status | Description |
|---|---|
| 200 OK | Shows if operation succeeded |
| 400 Bad Request | Shows when an invalid request or the requested service is not available |
post/contacts
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/contacts
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Request body
Response
Create Contact
Changes
No recorded changes to this operation across all 1 revision of this API.