/client/{uuid}

put

https://api.clientsuccess.com/v2/client/{uuid}

Update a client via PUT. Any properties not included will be set to null.

Path Params

uuid

string

required

Client UUID

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

enum

required

Client Status

Allowed:

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 1024

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 - overrides clientTypeTitle

clientTypeTitle

string

ClientSuccess name of client type - overridden by clientTypeId

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

Language

Credentials

Header

Response

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

*/*

200OK