---
title: "Request pairing of an Arrow client"
method: POST
path: "/arrow-clients/"
tags: ["arrow-clients"]
---

# Request pairing of an Arrow client

`POST /arrow-clients/`

## Request

- Base URL: `https://api.angelcam.com/v1`
- URL: `https://api.angelcam.com/v1/arrow-clients/`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://my.angelcam.com/oauth/authorize/`, token URL `https://my.angelcam.com/oauth/token/`
    - Password, token URL `https://api.angelcam.com/oauth/token/`
    - Scopes: `arrow_client_manage`
  - API key in header `Authorization`
- TypeScript: <https://skmtc.dev/angelcam/apis/angelcam-api/docs/arrow-clients/post.ts> (a function with typed inputs; its response is checked against the schema)

Request pairing of a given Arrow client with the current user account. One of the `uuid`, `angelbox_id` or `mac` parameter is required. In case the Arrow client has been paired already, the API will check if the current user can access the client. If the user can access the client, the API will respond with UUID of the client (i.e. the standard response). Otherwise, the API will respond with "Permission Denied".

Pairing via MAC address is only available upon request, otherwise API responds with "Permission Denied". When using MAC there will be MAC adress in the response instead of UUID.

## Request body

- object
  - `uuid` string, uuid: UUID of the paired Arrow client
  - `angelbox_id` string: AngelBox ID
  - `mac` string, MAC address: MAC address of the Arrow client

## Response `200`

OK

- ArrowClientPairingResponse
  - `uuid` string, uuid: UUID of the paired Arrow client
  - `mac` string, MAC address: MAC address of the paired Arrow client

## Other responses

- `400`: Body payload is invalid.
- `401`: Missing or invalid authorization.
- `403`: Missing permission.
- `404`: The specified resource was not found

---

[API](https://skmtc.dev/angelcam/apis/angelcam-api.md) - [All operations](https://skmtc.dev/angelcam/apis/angelcam-api/llms.txt) - [OpenAPI document](https://skmtc.dev/angelcam/apis/angelcam-api/revisions/dd1cdc3f2c23?raw)