Add hardware to IQ | Developers portal | Clay

Add hardware to IQ

This endpoint allows to add hardware, locks, repeaters to IQs.

What is an IQ? Check out our Glossary.

0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
request response 204response 400response 404 
Endpoint: "/v1.1/iqs/{id}/tree"
Method: PUT

Parameters:
Path {
id;
type: string, format: uuid;
required
id of the IQ
id}(string)
Body (application/json):
{
  
otp;
type: string
The OTP necessary for inserting new iq tree
"otp" : "string",
  
accessor_id;
type: string, format: uuid;
The accessor id whom generated the otp
"accessor_id" : "string",
  
iq_tree_items;
type: array
Represents list of tree items
"iq_tree_items" : [
    {
      
id;
type: string, format: uuid;
The id of the hardware (lock|repeater)
"id" : "string",
      
parent_id;
type: string, format: uuid;
The id of the parent HW
"parent_id" : "string",
      
hardware_type;
type: string
enumeration: [lock, repeater];
the type of the hardware
"hardware_type" : "string",
      
mac;
type: string
The mac adress of the hardware (lock|repeater)
"mac" : "string",
      
customer_reference;
type: string
The name/reference given to the hardware by the client
"customer_reference" : "string"
    }
  ]
}
            
Response Content Type (application/json):
Status: 204
Response Content Type (application/json):
{
  
ErrorCode;
type: string"ErrorCode" : "string",
  
Message;
type: string"Message" : "string"
}
Response Content Type (application/json):
{
  
ErrorCode;
type: string"ErrorCode" : "string",
  
Message;
type: string"Message" : "string"
}