Skip to main content
PATCH
Modifica un lead

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

If-Match
string

L'ETag ricevuto: la modifica passa solo se nessuno ha cambiato la risorsa (altrimenti 409 conflict, details.reason = version_mismatch).

Path Parameters

id
string<uuid>
required

Identificativo della risorsa.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Body

application/json
firstName
string
Required string length: 1 - 100
lastName
string | null
Maximum string length: 100
email
string<email> | null
Maximum string length: 254
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
phone
string | null
Required string length: 3 - 40
sourceDetail
string | null
Maximum string length: 200
status
enum<string>
Available options:
new,
contacted,
qualified,
proposal,
won,
lost
notes
string | null
Maximum string length: 5000
assignedTo
string<uuid> | null
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
estimatedValue
number | null
Required range: 0 <= x <= 100000000
nextFollowUpAt
string<date-time> | null
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
lostReason
string | null
Maximum string length: 500

Response

Il lead aggiornato.

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
facilityId
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
firstName
string
required
lastName
string | null
required
email
string | null
required
phone
string | null
required
source
enum<string>
required
Available options:
social_media,
website,
referral_link,
manual,
import,
phone,
walk_in,
other,
whatsapp
sourceDetail
string | null
required
status
enum<string>
required
Available options:
new,
contacted,
qualified,
proposal,
won,
lost
assignedTo
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
estimatedValue
number | null
required
notes
string | null
required
nextFollowUpAt
string | null
required
lastContactedAt
string | null
required
lostReason
string | null
required
convertedPatientId
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
convertedAt
string | null
required
createdAt
string
required
updatedAt
string
required
activities
object[]

Solo nel dettaglio.