> For the complete documentation index, see [llms.txt](https://docs.toomuchmedia.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.toomuchmedia.com/api/api-endpoints/cms/api-cms-link.md).

# /api/cms/link

## GET /api/cms/link

> Get details of link.

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/cms/link"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"get_cms_link":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["cms_link_id"]}}},"paths":{"/api/cms/link":{"get":{"description":"Get details of link.","tags":["/api/cms/link"],"parameters":[{"name":"cms_link_id","in":"query","schema":{"type":"integer"},"required":true}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/get_cms_link"}},"application/json":{"schema":{"$ref":"#/components/schemas/get_cms_link"}},"application/xml":{"schema":{"$ref":"#/components/schemas/get_cms_link"}}}}}}}}}
```

## POST /api/cms/link

> Add Link

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/cms/link"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"post_cms_link":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["cms_theme_id","slug","type","settings"]}}},"paths":{"/api/cms/link":{"post":{"description":"Add Link","tags":["/api/cms/link"],"parameters":[{"name":"cms_theme_id","in":"query","schema":{"type":"integer"},"required":true},{"name":"slug","in":"query","schema":{"type":"string"},"required":true},{"name":"type","in":"query","schema":{"type":"string"},"required":true},{"name":"settings","in":"query","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/post_cms_link"}},"application/json":{"schema":{"$ref":"#/components/schemas/post_cms_link"}},"application/xml":{"schema":{"$ref":"#/components/schemas/post_cms_link"}}}}}}}}}
```

## DELETE /api/cms/link

> Delete Link

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/cms/link"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"delete_cms_link":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["cms_link_id"]}}},"paths":{"/api/cms/link":{"delete":{"description":"Delete Link","tags":["/api/cms/link"],"parameters":[{"name":"cms_link_id","in":"query","schema":{"type":"integer"},"required":true}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/delete_cms_link"}},"application/json":{"schema":{"$ref":"#/components/schemas/delete_cms_link"}},"application/xml":{"schema":{"$ref":"#/components/schemas/delete_cms_link"}}}}}}}}}
```

## PATCH /api/cms/link

> Edit Link

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/cms/link"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"patch_cms_link":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["cms_link_id","slug","type","settings"]}}},"paths":{"/api/cms/link":{"patch":{"description":"Edit Link","tags":["/api/cms/link"],"parameters":[{"name":"cms_link_id","in":"query","schema":{"type":"integer"},"required":true},{"name":"slug","in":"query","schema":{"type":"string"},"required":true},{"name":"type","in":"query","schema":{"type":"string"},"required":true},{"name":"settings","in":"query","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/patch_cms_link"}},"application/json":{"schema":{"$ref":"#/components/schemas/patch_cms_link"}},"application/xml":{"schema":{"$ref":"#/components/schemas/patch_cms_link"}}}}}}}}}
```