External Links

List External Links

get

Retrieve shared sidebar links shown in the white-label console.

Authorizations

ApiKey

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Short code or application-level status code for this resource.

get/external-links

HTTPcURLJavaScriptPython

GET /agency/external-links HTTP/1.1
Host: api.moregoodreviews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

{
  "success": true,
  "code": 200,
  "data": [
    {
      "id": 3,
      "uuid": "04eb8a04-8438-43d5-9d22-869ad5dc7d4c",
      "label": "Book Online",
      "url": "https://acmedental.example.com/book"
    }
  ]
}

Create External Link

post

Add a shared navigation link for client console users.

Authorizations

ApiKey

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Object containing response data for this resource.

labelstringRequired

Label for this resource.

urlstringRequired

URL for the external resource.

Responses

200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Short code or application-level status code for this resource.

post/external-links

HTTPcURLJavaScriptPython

POST /agency/external-links HTTP/1.1
Host: api.moregoodreviews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "label": "Book Online",
  "url": "https://acmedental.example.com/book"
}

200

Success

{
  "success": true,
  "code": 200,
  "data": {
    "id": 3,
    "uuid": "04eb8a04-8438-43d5-9d22-869ad5dc7d4c",
    "label": "Book Online",
    "url": "https://acmedental.example.com/book"
  }
}

Update External Link

put

Change the label or URL for a shared navigation link.

Authorizations

ApiKey

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

link_idintegerRequired

Unique numeric identifier for the external link.

Body

application/json

Object containing response data for this resource.

labelstringRequired

Label for this resource.

urlstringRequired

URL for the external resource.

Responses

200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Short code or application-level status code for this resource.

put/external-links/{link_id}

HTTPcURLJavaScriptPython

PUT /agency/external-links/{link_id} HTTP/1.1
Host: api.moregoodreviews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "label": "Schedule Visit",
  "url": "https://acmedental.example.com/schedule"
}

200

Success

{
  "success": true,
  "code": 200,
  "data": {
    "id": 3,
    "uuid": "04eb8a04-8438-43d5-9d22-869ad5dc7d4c",
    "label": "Schedule Visit",
    "url": "https://acmedental.example.com/book"
  }
}

Delete External Link

delete

Remove a shared navigation link from the client console.

Authorizations

ApiKey

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

link_idintegerRequired

Unique numeric identifier for the external link.

Responses

200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Short code or application-level status code for this resource.

delete/external-links/{link_id}

HTTPcURLJavaScriptPython

DELETE /agency/external-links/{link_id} HTTP/1.1
Host: api.moregoodreviews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

{
  "success": true,
  "code": 200
}