/client

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

Create a new client

Body Params

custom

object

name

string

required

length between 0 and 255

Client Name

siteUrl

string

length between 0 and 1024

Client Website URL

logoUrl

string

length between 0 and 1024

Logo Client

status

string

required

Client Status

active

boolean

required

True/False whether client is active

inceptionDate

date

Desired start date of client (format: YYYY-MM-DD)

terminatedDate

date

Date Client was terminated (format: YYYY-MM-DD)

street

string

length between 0 and 100

Street Address

city

string

length between 0 and 100

City

state

string

length between 0 and 100

State or Province

zip

string

length between 0 and 20

Client zip code

country

string

length between 0 and 100

Country

region

object

Region

timezone

string

length between 0 and 60

Time zone name

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

externalId

string

length between 0 and 100

External ID

salesforceAccountId

string

length between 0 and 18

Salesforce Account Id

zendeskId

string

length between 0 and 200

ID of Client associated with Zendesk

freshdeskId

string

length between 0 and 200

ID of Client associated with Freshdesk

usageId

string

length between 0 and 200

ID given to tie Client to Usage

stripeId

string

length between 0 and 200

ID of Client associated with Stripe

externalStatusId

string

length between 0 and 200

ID of Client associated with Status

npsScore

int32

-100 to 100

Client NPS score

note

string

Note

createdByEmployeeId

int64

≥ 0

ClientSuccess system ID of the employee who created client

modifiedByEmployeeId

int64

≥ 0

ClientSuccess system ID of the employee who last modified client

managedByEmployeeId

int64

≥ 0

ClientSuccess system ID of the employee who is client's assigned CSM

assignedSalesRepId

int64

≥ 0

ClientSuccess system ID of employee who is client's assigned sales rep

assignedSalesRep

string

length between 0 and 45

Assigned sales rep (full name)

clientTypeId

int64

≥ 0

ClientSuccess system ID of client type

activeClientSuccessCycleId

int64

≥ 0

ClientSuccess system ID of the SuccessCycle template that should be assigned to the client

primaryContactId

int64

≥ 0

ClientSuccess system ID of the contact who is the client's primary contact

parentClientId

int64

≥ 0

ClientSuccess system ID of the client who is the client's parent client

accTeamingRoles

array of objects

Account Teaming Roles

accTeamingRoles

Response

Response body

object

success

boolean

message

string

errors

object

objectName

string

errors

array of objects

errors

object

code

string

field

string

message

string

data

object

int64

createdTime

date-time

modifiedTime

date-time

uuid

string

name

string

logoUrl

string

siteUrl

string

zip

string

status

string

ACTIVE INACTIVE TRIAL TERMINATED

inceptionDate

date-time

assignedSalesRep

string

active

boolean

successScore

number

activeClientSuccessCycleId

int64

zendeskId

string

freshdeskId

string

terminatedDate

date-time

salesforceAccountId

string

usageId

string

stripeId

string

externalStatusId

string

street

string

city

string

state

string

country

string

region

object

Region

timezone

string

externalId

string

npsScore

int32

note

string

currency

string

USD AUD GBP CAD EUR AED AFN ALL AMD ANG AOA ARS AWG AZN BAM BBD BDT BGN BHD BIF BMD BND BOB BOV BRL BSD BTN BWP BYN BZD CDF CHE CHF CHW CLP CNY COP COU CRC CUC CUP CVE CZK DJF DKK DOP DZD EGP ERN ETB FJD FKP GEL GHS GIP GMD GNF GTQ GYD HKD HNL HRK HTG HUF IDR ILS INR IQD IRR ISK JMD JOD JPY KES KGS KHR KMF KPW KRW KWD KYD KZT LAK LBP LKR LRD LSL LYD MAD MDL MGA MKD MMK MNT MOP MRU MUR MVR MWK MXN MXV MYR MZN NAD NGN NIO NOK NPR NZD OMR PAB PEN PGK PHP PKR PLN PYG QAR RON RSD RUB RWF SAR SBD SCR SDG SEK SGD SHP SLL SOS SRD SSP STN SVC SYP SZL THB TJS TMT TND TOP TRY TTD TWD TZS UAH UGX USN UYI UYU UYW UZS VES VND VUV WST XAF XBA XBB XBC XBD XCD XOF XPF XSU XUA YER ZAR ZMW ZWL

entityType

string

accTeamingRoles

array of objects

accTeamingRoles

object

int64

tenantId

int64

clientId

int64

roleId

int64

employeeId

int64

employee

object

role

object

assignedSalesRepAssociation

object

managedByEmployee

object

createdByEmployee

object

modifiedByEmployee

object

primaryContact

object

clientType

object

clientSegmentId

int64

segment

string

parentClient

object

noteAsText

string

modifiedByEmployeeId

int64

address

string

externalSystems

object

Has additional fields

action

string

Language

Credentials

Header


xxxxxxxxxx
10
1
curl --request POST \
2
     --url https://api.clientsuccess.com/v2/client \
3
     --header 'accept: */*' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "status": "ACTIVE",
8
  "active": true
9
}
10
'

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

*/*

200OK