Chilkat Online Tools

lianja / New FreshBooks / Invite Team Member to Project(s)

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

loHttp = createobject("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"
//     }
//   ]
// }

loJson = createobject("CkJsonObject")
loJson.UpdateString("capacity","manager")
loJson.UpdateString("to_email","yourteammemberemail@freshbooks.com")
loJson.UpdateInt("invitable_id",123)
loJson.UpdateString("invitable_type","business")
loJson.UpdateInt("groups[0].group_id",6360979)
loJson.UpdateString("groups[0].capacity","manager")
loJson.UpdateInt("groups[1].group_id",6360987)
loJson.UpdateString("groups[1].capacity","manager")
loJson.UpdateInt("groups[2].group_id",6360952)
loJson.UpdateString("groups[2].capacity","manager")

// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Content-Type","application/json")

loResp = loHttp.PostJson3("https://api.freshbooks.com/auth/api/v1/users/invitation","application/json",loJson)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJson
    return
endif

? str(loResp.StatusCode)
? loResp.BodyStr
release loResp


release loHttp
release loJson

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": [
  ]
}