TCL / New FreshBooks / Invite Team Member to Project(s)
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "capacity": "manager",
# "to_email": "yourteammemberemail@freshbooks.com",
# "invitable_id": 123,
# "invitable_type": "business",
# "groups": [
# {
# "group_id": 6360979,
# "capacity": "manager"
# },
# {
# "group_id": 6360987,
# "capacity": "manager"
# },
# {
# "group_id": 6360952,
# "capacity": "manager"
# }
# ]
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "capacity" "manager"
CkJsonObject_UpdateString $json "to_email" "yourteammemberemail@freshbooks.com"
CkJsonObject_UpdateInt $json "invitable_id" 123
CkJsonObject_UpdateString $json "invitable_type" "business"
CkJsonObject_UpdateInt $json "groups[0].group_id" 6360979
CkJsonObject_UpdateString $json "groups[0].capacity" "manager"
CkJsonObject_UpdateInt $json "groups[1].group_id" 6360987
CkJsonObject_UpdateString $json "groups[1].capacity" "manager"
CkJsonObject_UpdateInt $json "groups[2].group_id" 6360952
CkJsonObject_UpdateString $json "groups[2].capacity" "manager"
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://api.freshbooks.com/auth/api/v1/users/invitation" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
exit
}
puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"capacity": "manager",
"to_email": "yourteammemberemail@freshbooks.com",
"invitable_id": {{businessid}},
"invitable_type": "business",
"groups": [
{
"group_id": 6360979,
"capacity": "manager"
},
{
"group_id": 6360987,
"capacity": "manager"
},
{
"group_id": 6360952,
"capacity": "manager"
}
]
}'
https://api.freshbooks.com/auth/api/v1/users/invitation
Postman Collection Item JSON
{
"name": "Invite Team Member to Project(s)",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"capacity\": \"manager\",\n \"to_email\": \"yourteammemberemail@freshbooks.com\",\n \"invitable_id\": {{businessid}},\n \"invitable_type\": \"business\",\n \"groups\": [\n {\n \"group_id\": 6360979,\n \"capacity\": \"manager\"\n },\n {\n \"group_id\": 6360987,\n \"capacity\": \"manager\"\n },\n {\n \"group_id\": 6360952,\n \"capacity\": \"manager\"\n }\n ]\n}"
},
"url": {
"raw": "https://api.freshbooks.com/auth/api/v1/users/invitation",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"auth",
"api",
"v1",
"users",
"invitation"
]
}
},
"response": [
]
}