Update a client detail

put

https://api.clientsuccess.com/v1/clients/{clientId}

Update Client details. An empty array [] may be passed in for customFieldValues.

WARNING: This is NOT a patch operation.   Any values not included will be set to null.

Path Params

clientId

integer

required

Id of a Client.

Body Params

number

required

ID of the Client

externalId

string

ID given to the Client by the user

name

string

required

Name of the Client

siteUrl

string

Website for the Client

clientSegmentId

number

Client type ID

zip

number

Zip code for the Client's location

modifiedByEmployeeId

number

ID of employee that last modified the account

statusId

number

Status of the Client (1/active, 2/inactive, 3/trial, 4/terminated)

inceptionDate

string

Date the Cliet was created (yyyy-mm-dd format)

createdByEmployee

number

ID of the employee who created the account

linkedinUrl

string

Site url for the Client

managedByEmployeeId

string

ID of the assigned CSM

active

boolean

States if the Client is active or not

successScore

number

Pulse score of the Client

activeClientSuccessCycleId

number

ID of the current successCycle

crmCustomerId

string

Deprecated, Always null

crmCustomerUrl

string

Deprecated, Always null

zendeskId

string

ID of Client in relation to zendesk

deskId

string

ID of Client in relation to desk

freshdeskId

string

ID of Client in relation to freshdesk

uservoiceId

string

ID of Client in relation to uservoice

assignedSalesRep

string

Name of the assigned sales representative

customFieldValues

object

required

successCycleId

number

ID of the current successCycle

salesforceAccountId

string

ID of the salesforce account

jiraId

string

ID of client in relation to jira

npsScore

number

Desired NPS score of client

Response

200