Skip to main content
GET
/
api
/
workspace
/
{workspaceId}
/
onboarding-link
Obtener Link de Onboarding
curl --request GET \
  --url https://api.plazbot.com/api/workspace/{workspaceId}/onboarding-link \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "code": 123,
  "errorCode": "<string>",
  "message": "<string>",
  "data": {
    "id": "<string>",
    "type": "<string>",
    "token": "<string>",
    "shortUrl": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z",
    "isActive": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Token de autenticacion Bearer. Obtenga el token usando el endpoint /api/user/login

Path Parameters

workspaceId
string
required

ID del workspace

Query Parameters

type
enum<string>
required

Tipo de integracion. Valores validos: whatsapp, whatsapp_business, facebook, instagram

Available options:
whatsapp,
whatsapp_business,
facebook,
instagram

Response

Link de onboarding obtenido exitosamente

success
boolean
required

Indica si la operacion fue exitosa

code
integer
required

Codigo HTTP de la respuesta

errorCode
string | null
required

Codigo de error, null si no hay error

message
string
required

Mensaje descriptivo del resultado

data
object
required

Datos del link de onboarding