WayloAIWaylo Docs
APIReferenceDestinations

Update destination

PATCH
/destinations/{id}

Change a destination’s settings or retire it. Does not touch the signing secret.

Access: workspace_admin · API key destinations:write

Authorization

api-key
headerAuthorizationBearer <sk_waylo_<lookup><secret><checksum>>

Path Parameters

id*string

Header Parameters

Authorization*string

Your API key.

Request Body

application/json
  1. body
name?string
Lengthlength <= 100
url?string
Lengthlength <= 2048
credentialId?|
Formatuuid
sendTestCalls?boolean
instructions?string
Lengthlength <= 2000
active?boolean

Response Body

Updated

application/json
  1. response
id*string
Formatuuid
workspaceId*string
Formatuuid
name*string
url*string
credentialId*|
Formatuuid
credentialName*string|null
credentialActive*boolean|null
sendTestCalls*boolean
instructions*string
active*boolean
createdByUserId*|
Formatuuid
createdByUserName*string|null
updatedByUserId*|
Formatuuid
updatedByUserName*string|null
createdAt*string
Formatdate-time
updatedAt*string
Formatdate-time
Example Request
curl -X PATCH 'https://api.poc.app.waylovoice.ai/destinations/string' \  -H 'Authorization: Bearer sk_waylo_...' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",  "name": "string",  "url": "string",  "credentialId": "f568fec0-10b6-4b94-9daf-e62c50c9bf3e",  "credentialName": "string",  "credentialActive": true,  "sendTestCalls": true,  "instructions": "string",  "active": true,  "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",  "createdByUserName": "string",  "updatedByUserId": "b38eaad7-8efa-49e7-b0aa-619916a3821e",  "updatedByUserName": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Rotate signing secret POST

Replace the signing secret. The new one is in the response and signs every delivery sent from now on. **Access:** workspace_admin · API key `destinations:write`

Delete a document DELETE

Remove the document, its chunks and its stored object. **Access:** workspace_admin · API key `documents:write`