Insert a new contact record

post

https://rls.congacloud.com/api/data/v1/Contact

Validates the record details and inserts if it does not exist in the given object.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

IncludeRecordPayloadInResponse

boolean

Set to true to get the payload in response.

Note: Default value set to false.

Body Params

Details about the record. For example: Name = "Mark", Description = "Description", ID = "263rd72c-edfc-4dc5-b72f-45104fe5ef43", externalId = "4614d72c-edfd-4dc5-b72f-45104fe5ef43".

Note: The fields/properties must be part of the schema/metadata created for the custom object (in this case, Name, Description, ID, and externalId must be schema fields). The schema and metadata can be generated using the Schema Manager APIs.

Refer to the following table to understand the behavior when you pass ID and/or External ID.

         | ID in payload? | ExternalId in payload? | Behavior | Validation |
         |----------------|------------------------|----------|------------|
         | Yes            | Yes                    | Create a record using the ID field value as provided in the payload. | ExternalId unique validation |
         | Yes            | No                     | Create a record using the ID field value as provided in the payload and set the ExternalId to null. | NA |
         | No             | Yes                    | Generate a new GUID and create a record using the ID field value with the new GUID value. | ExternalId unique validation |
         | No             | No                     | Generate a new GUID and create a record using the ID field value with the new GUID value and set the ExternalId to null. | NA |

Contact Request Example

Account

object | null

Account Id and Name associated with record

Name

string | null

Name for record

FirstName

string | null

First name for record

LastName

string | null

Last name for record

AssistantName

string | null

Name of assistant

Department

string | null

Department name

Description

string | null

Description for the record

DoNotCall

string | null

Call options.

string | null

Email Id

IsEmailBounced

boolean

Is Email bounced

EmailBouncedDate

string | null

Email bounced date

EmailBouncedReason

string | null

Email bounced reason

LeadSource

string | null

Lead source

AssistantPhone

string | null

Assistant phone number

Birthdate

string | null

Birthdate

Fax

string | null

Fax number

HasOptedOutOfEmail

string | null

Email settings

HasOptedOutOfFax

string | null

Fax settings

HomePhone

string | null

Home phone number

MailingAddress

string | null

Mailing address

MailingCity

string | null

Mailing city

MailingCountry

string | null

Mailing country

MailingCountryCode

string | null

Mailing country code

MailingPostalCode

string | null

Mailing postal code

MailingState

string | null

Mailing state

MailingStreet

string | null

Mailing street

MobilePhone

string | null

Mobile phone number

OtherAddress

string | null

Alternate address

OtherCity

string | null

Alternate city

OtherCountry

string | null

Alternate country

OtherCountryCode

string | null

Alternate country code

OtherPhone

string | null

Alternate phone number

OtherPostalCode

string | null

Alternate postal code

OtherState

string | null

Alternate state

OtherStreet

string | null

Alternate street

Owner

object | null

Owner Id and Name associated with record

Phone

string | null

Phone Number

PhotoUrl

string | null

Photo Url

Salutation

string | null

Salutation

Title

string | null

Title

Responses

400

Found unknown field(s)

201Created

403Forbidden

500Internal Server Error