Skip to content
KynectLocal Docs

Update lead status

PUT
/v1/brands/{brandId}/leads/{leadId}/status
 
curl --request PUT \
  --url https://kynectlocal-production.up.railway.app/v1/v1/brands/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/leads/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/status \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
brandId
required
string format: uuid

Brand identifier

leadId
required
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

Media type application/json
object
data
required
object
lead
required
object
id
required

Lead identifier

string format: uuid
brandId
required

Parent brand

string format: uuid
formId
required

Form that generated this lead

string format: uuid
locationId
required

Location this lead belongs to

string | null format: uuid
status
required

Lead status

string
Allowed values: new viewed archived
fields
required

Submitted field values

object
key
additional properties
sourceType
required

Source type: organic | promotion | etc.

string | null
utmSource
required

UTM source parameter

string | null
utmMedium
required

UTM medium parameter

string | null
utmCampaign
required

UTM campaign parameter

string | null
createdAt
required

Submission timestamp

string format: date-time
Example 
{
  "data": {
    "lead": {
      "status": "new"
    }
  }
}

400

Section titled “400 ”

Validation error

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

401

Section titled “401 ”

Unauthenticated

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

403

Section titled “403 ”

Forbidden

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

404

Section titled “404 ”

Not found

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

422

Section titled “422 ”

Unprocessable

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}