/contact

post https://api.clientsuccess.com/v2/contact

Create a new contact

Body Params

custom

object

tenantClientId

int64

required

≥ 0

ClientSuccess system Client ID

status

string

required

Contact Status

firstName

string

length between 0 and 255

Contact first name

lastName

string

length between 0 and 255

Contact last name

title

string

length between 0 and 512

Contact title

string

length between 0 and 255

Contact email address

phone

string

length between 0 and 255

Contact phone number

mobile

string

length between 0 and 255

Contact mobile phone number

advocate

boolean

required

Whether this contact is an advocate

champion

boolean

required

Whether this contact is an champion

executiveSponsor

boolean

required

Whether this contact is an executive sponsor

keyContact

boolean

required

Whether this contact is a key contact

starred

boolean

required

Whether this contact is starred

street

string

length between 0 and 512

Contact street address

city

string

length between 0 and 512

Contact city

state

string

length between 0 and 255

Contact state

zip

string

length between 0 and 255

Contact zip

country

string

length between 0 and 255

Contact country

timezone

string

length between 0 and 255

Time zone name

referenced from the 'tz database' https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

notes

string

length between 0 and 3000

Notes regarding contact

linkedinUrl

string

length between 0 and 255

LinkedIn Url

externalId

string

length between 0 and 36

External ID

salesforceId

string

length between 0 and 18

Salesforce Contact ID

usageId

string

length between 0 and 100

ID given to tie Contact to Usage

Response

Language

Credentials

Header


xxxxxxxxxx
14
1
curl --request POST \
2
     --url https://api.clientsuccess.com/v2/contact \
3
     --header 'accept: */*' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "status": "ACTIVE",
8
  "advocate": true,
9
  "champion": true,
10
  "executiveSponsor": true,
11
  "keyContact": true,
12
  "starred": true
13
}
14
'

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200OK