Skip to main content
PUT
Rename leads and deals

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Body

application/json
lead
object | null
deal
object | null

Response

200 - application/json

Default Response

term
enum<string>
required

The object being named. API paths, fields and operationIds keep this name.

Available options:
lead,
deal
singular
string
required

Display name for one record, e.g. Project. Lead / Deal when not customised.

Required string length: 1 - 50
Pattern: ^(?=.*[\p{L}\p{N}])[^{}<>#\p{Cc}\p{Cf}\p{Zl}\p{Zp}]+$
plural
string
required

Display name for several records, e.g. Projects. Leads / Deals when not customised.

Required string length: 1 - 50
Pattern: ^(?=.*[\p{L}\p{N}])[^{}<>#\p{Cc}\p{Cf}\p{Zl}\p{Zp}]+$
is_custom
boolean
required

True when the company has set its own name for this term.