Create / Update Contact

Creating and updating a contact from the API can be done by posting your contact object to Supportbench.

The only difference between contact creations and updates is including a contact id within the contact object.

When creating or updating a contact, the below fields are available to you.

Name

Required

Limit

Default

Availability

Summary

id_prefix

no

5 characters

"CT"

New

The prefix of the company. You can assign new contact prefix's within the API administration section.

id_source

no

25 characters

New

The source id of the contact. You can assign custom ID's from existing systems or assign your own id.

id

no - when creating
yes - when updating

30 characters

Update

The full company id including the prefix.

company_id

no

30 characters

New / Update

The company id to assign to this company.

first_name

yes

250 characters

New / Update

The contact's first name.

last_name

yes

250 characters

New / Update

The contact's last name.

title

no

100 characters

New / Update

The job title of the contact.

address

no

250 characters

New / Update

The mailing address of the company.

city

no

100 characters

New / Update

The mailing city of the company.

zip

no

25 characters

New / Update

The mailing zip / postal code of the company.

state

no

50 characters

New / Update

The mailing state or province of the company.

country

no

5 characters

New / Update

The 2 character ISO country code of the company. i.e. US, CA. Country code can be found here: https://countrycode.org/

email

no

500 characters

New / Update

The primary email address of the user.

phone

no

50 characters

New / Update

The primary phone number of the contact.

phone_ext

no

50 characters

New / Update

The extension of the primary phone number of the contact.

mobile

no

10 characters

New / Update

The primary mobile / cell number of the contact.

active

no

Boolean

New / Update

Is the company active or not.

fields

no

See field object

New / Update

A field array of custom fields to insert or update. Please see the field object below.

Field Object

Name

Required

Limit

Default

Summary

id

yes

Integer

The field id of the field you wish to update. The field id must map to a valid field in the contact.

value

yes

Dropdown list - Integer
Checkbox - Boolean
Text box - Unlimited

The value of the custom field. The value is dependent on the field type.

Language
Credentials