Skip to content
KynectLocal Docs

Connect integration

POST
/v1/brands/{brandId}/integrations
 
curl --request POST \
  --url https://kynectlocal-production.up.railway.app/v1/v1/brands/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/integrations \
  --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

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

Media type application/json
object
data
required
object
integration
required
object
key
required

Integration identifier key (e.g., google_business)

string
name
required

Integration display name

string
description
required

Short description

string
category
required

Integration category

string
logoUrl
required

Logo URL

string | null
entitlementRequired
required

Entitlement required to use this integration

string | null
entitled
required

Whether the current brand is entitled to use this integration

boolean
status
required

Connection status

string
Allowed values: not_connected connected error
connectedAt
required

Connection timestamp

string | null format: date-time
lastVerifiedAt
required

Last verification timestamp

string | null format: date-time
errorMessage
required

Last error message

string | null
credentialFields
required

Credential field definitions

Array<object>
object
key
required

Field key

string
label
required

Human-readable label

string
type
required

Input type (password fields are never returned in plaintext)

string
Allowed values: text password
required
required

Whether this credential field is required

boolean
placeholder

Placeholder text

string
docsUrl
required

Documentation URL

string | null
affiliateUrl
required

Affiliate/partner URL

string | null
navLabel
required

Navigation label override

string | null
connectedCredentialKeys
required

Keys of credentials that have been saved

Array<string>
connectedCredentials
required

Decrypted values for text-type fields only; password fields are never returned

object
key
additional properties
string
Example 
{
  "data": {
    "integration": {
      "status": "not_connected",
      "credentialFields": [
        {
          "type": "text"
        }
      ]
    }
  }
}

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"
  }
}