Contacts
Authorizations
Path parameters
user-idstringRequired
numeric user id
Responses
200
the response
application/json
get
/users/{user-id}/contacts/emailsGET /api/users/{user-id}/contacts/emails HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200
the response
[
{
"id": 1,
"target": "text",
"status": "OK"
}
]Authorizations
Path parameters
user-idstringRequired
numeric user id
Body
targetstringOptional
Responses
201
the response
application/json
post
/users/{user-id}/contacts/emailsPOST /api/users/{user-id}/contacts/emails HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 17
{
"target": "text"
}201
the response
{
"id": 1,
"target": "text",
"status": "OK"
}Authorizations
Path parameters
user-idstringRequired
numeric user id
idnumberRequired
entity ID
Responses
200
the response
application/json
get
/users/{user-id}/contacts/emails/{id}GET /api/users/{user-id}/contacts/emails/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200
the response
{
"id": 1,
"target": "text",
"status": "OK"
}Authorizations
Path parameters
user-idstringRequired
numeric user id
idnumberRequired
entity ID
Body
targetstringOptional
Responses
200
the response
application/json
put
/users/{user-id}/contacts/emails/{id}PUT /api/users/{user-id}/contacts/emails/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 17
{
"target": "text"
}200
the response
{
"id": 1,
"target": "text",
"status": "OK"
}Authorizations
Path parameters
user-idstringRequired
numeric user id
idnumberRequired
entity ID
Responses
204
if deletion was successful
delete
/users/{user-id}/contacts/emails/{id}DELETE /api/users/{user-id}/contacts/emails/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
204
if deletion was successful
No content
Authorizations
Path parameters
user-idstringRequired
numeric user id
Responses
200
the response
application/json
get
/users/{user-id}/contacts/phone-numbersGET /api/users/{user-id}/contacts/phone-numbers HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200
the response
[
{
"id": 1,
"regionCode": "text",
"target": "text",
"primary": true,
"status": "OK"
}
]Authorizations
Path parameters
user-idstringRequired
numeric user id
Body
regionCodestringOptional
targetstringOptional
primarybooleanOptional
May only be enabled for a single phone number contact at a time
Responses
201
the response
application/json
post
/users/{user-id}/contacts/phone-numbersPOST /api/users/{user-id}/contacts/phone-numbers HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 52
{
"regionCode": "text",
"target": "text",
"primary": true
}201
the response
{
"id": 1,
"regionCode": "text",
"target": "text",
"primary": true,
"status": "OK"
}Authorizations
Path parameters
user-idstringRequired
numeric user id
idnumberRequired
entity ID
Responses
200
the response
application/json
get
/users/{user-id}/contacts/phone-numbers/{id}GET /api/users/{user-id}/contacts/phone-numbers/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200
the response
{
"id": 1,
"regionCode": "text",
"target": "text",
"primary": true,
"status": "OK"
}Authorizations
Path parameters
user-idstringRequired
numeric user id
idnumberRequired
entity ID
Body
regionCodestringOptional
targetstringOptional
primarybooleanOptional
May only be enabled for a single phone number contact at a time
Responses
200
the response
application/json
put
/users/{user-id}/contacts/phone-numbers/{id}PUT /api/users/{user-id}/contacts/phone-numbers/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 52
{
"regionCode": "text",
"target": "text",
"primary": true
}200
the response
{
"id": 1,
"regionCode": "text",
"target": "text",
"primary": true,
"status": "OK"
}Authorizations
Path parameters
user-idstringRequired
numeric user id
idnumberRequired
entity ID
Responses
204
if deletion was successful
delete
/users/{user-id}/contacts/phone-numbers/{id}DELETE /api/users/{user-id}/contacts/phone-numbers/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
204
if deletion was successful
No content
Last updated
Was this helpful?