Jump to Content
API Reference
v1.0
v2.0
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
v2.0
API Reference
/contract/addLink
Search
JUMP TO
ClientSuccess API
Pulse
/pulse/{uuid}
get
/pulse/search
get
/pulse
post
/pulse/bulk
post
Client Note
/clientNote/{id}
get
/clientNote/{id}
put
/clientNote/{id}
delete
/clientNote/{id}
patch
/clientNote/search
get
/clientNote
post
/clientNote/bulk
post
/clientNote/{type}/{externalSystemId}/upsert
post
/clientNote/bulk/upsert
post
Client
/client
post
/client/bulk
post
/client/{uuid}
get
/client/{uuid}
put
/client/{uuid}
delete
/client/{uuid}
patch
/client/upsert
post
/client/search
get
/client/{uuid}/updateExternalSystems
post
/client/{uuid}/removeExternalSystems
post
/client/logo/{uuid}
post
/client/{uuid}/patchExternalSystems
patch
/workato/client/{externalSystemType}/missing
post
/workato/client/upsert/batch
post
Contact
/contact
post
/contact/{uuid}
get
/contact/{uuid}
put
/contact/{uuid}
delete
/contact/{uuid}
patch
/contact/search
get
/contact/{uuid}/updateExternalSystems
post
/contact/{uuid}/removeExternalSystems
post
/contact/bulk
post
/contact/{uuid}/patchExternalSystems
patch
/workato/contact/upsert/batch
post
Contract
/contract
post
/contract/{contractUuid}
get
/contract/{contractUuid}
put
/contract/{contractUuid}
delete
/contract/{contractUuid}
patch
/contract/search
get
/contract/{contractUuid}/addItems
post
/contract/{contractUuid}/updateItems
post
/contract/{contractUuid}/patchItems
post
/contract/{contractUuid}/deleteItems
post
/contract/{contractUuid}/note
post
/contract/{contractUuid}/note/search
get
/contract/{contractUuid}/note/{noteUuid}
put
/contract/{contractUuid}/note/{noteUuid}
delete
/contract/{contractUuid}/note/{noteUuid}
patch
/contract/{contractUuid}/attachment
post
/contract/{contractUuid}/attachment/{attachmentUuid}
get
/contract/{contractUuid}/attachment/{attachmentUuid}
put
/contract/{contractUuid}/attachment/{attachmentUuid}
delete
/contract/{contractUuid}/attachment/{attachmentUuid}
patch
/contract/{contractUuid}/attachment/{attachmentUuid}/uploaded
put
/contract/{contractUuid}/attachment/search
get
/contract/addLink
post
/contract/removeLink
post
/contract/{contractUuid}/linkCandidateSearch
get
/contract/{contractUuid}/updateExternalSystems
post
/contract/{contractUuid}/removeExternalSystems
post
/contract/bulk
post
/contract/upsert
post
/contract/{contractUuid}/patchExternalSystems
patch
/workato/contract/upsert/batch
post
/contract/externalSystem
get
/contract/v2/{contractUuid}/addItems
post
/contract/v2/{contractUuid}/patchItems
post
/contract/v2/{contractUuid}/deleteItems
post
/contract/items/search
get
/contract/v2/{uuid}/reasonCodes
get
Product
/product/{uuid}
get
/product/{uuid}
put
/product/{uuid}
delete
/product/{uuid}
patch
/product/search
get
/product/externalSystems
get
/product
post
/product/bulk
post
/product/{type}/{externalSystemId}/replace
post
/product/{type}/{externalSystemId}/upsert
post
/product/{uuid}/updateExternalSystems
post
/product/{uuid}/removeExternalSystems
post
Custom Fields
/customfield/all/{resourceType}
get
Account Teaming Roles
/teamingRole
get
/teamingRole
post
/teamingRole/deactivate/{id}
patch
/teamingRole/change/sequence
patch
/teamingRole/activate/{id}
patch
/teamingRole/{id}
get
/teamingRole/{id}
delete
/teamingRole/search
get
/teamingRole/primary
get
Surveys
/survey/response
post
/survey/response/{uuid}
get
/survey/response/{uuid}
post
/survey/response/{uuid}
delete
/survey/response/bulk
post
/survey/dashboard/response
post
/survey/report/response
post
/survey/search/response
post
/contact/upsert
post
ClientSuccess SuccessCycle API
SuccessCycle
Get all SuccessCycles.
get
Get the identified successCycle.
get
Task Service API
Milestone API
Create milestone
post
Fetch milestones for Gantt
post
Get milestone tasks info by project uuid
get
Create milestone template
post
Get milestone template by id
get
Patch milestone template
patch
Create milestone from template
post
Get milestone by uuid
get
Patch milestone
patch
Project API
Create project
post
Get page project
post
Create project from template
post
Get total project metrics
post
Get project by uuid
get
Patch project
patch
Project Template API
Create project template
post
Get page project template
post
Get project template by uuid
get
Patch project template
patch
Project Watcher API
Link employee to project
post
Task API
Create task
post
Get all tasks
post
Get task by uuid
get
Patch task
patch
Update task note
patch
Patch task field
patch
ClientSuccess Usage API
Usage
Add an event
post
Add bulk events
post
Powered by
/contract/addLink
post
https://api.clientsuccess.com/v2/contract/addLink
Add contract link
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
Header
Log in to use your API keys
RESPONSE
Click
Try It!
to start a request and see the response here!