Skip to main content
POST
/
api
/
platform
/
v1
/
clients
/
{id}
/
external_link
Links a BSPK Client with a Client in an external backend system
curl --request POST \
  --url https://api.bspk.com/api/platform/v1/clients/{id}/external_link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_id": "CLI-789"
}
'
BSPK manages various resources that you may want to sync with your backend. Currently, we support linking Clients. Once a Client is linked, you can receive updates through our Webhook API, allowing you to identify and match BSPK Clients with those in your system using the external_id attribute. Checking External Link Support To link an entity from your backend to BSPK, check if the entity supports the external_link endpoint. Supported Entities Currently, the following entities can be externally linked:

​
Entities

Currently, we support the following entities to be externally linked:
Entity
Client

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

BSPK's unique identifier of the client.

Body

application/json
​
external_id
string
required

Client's unique identifier provided by your backend system.

Example:

"CLI-789"

Response

Successful response