> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.caresquareapi.com/api-reference/contacts/team-members/create-participant-team-member/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.caresquareapi.com/_mcp/server. # Add team member POST https://api.caresquareapi.com/api/public/v1/participants/{participant_id}/team-members Content-Type: application/json Add a team member to a participant and grant permissions. Omit `email` to add a contact without portal login; those contacts can only be granted `no_access` (omit `permissions`, send an empty list, or send `no_access`). Any other permission without an email returns 400. Permissions accept slugs such as `view_budget`, or the labels/UUIDs from GET /permissions. Limited to one create every 5 seconds per API key; exceeding that returns 429 with a `Retry-After` header. This endpoint does not send a portal-access email. Reference: https://docs.caresquareapi.com/api-reference/contacts/team-members/create-participant-team-member ## Authentication - `Authorization` header (bearer token, required) — API key issued for your account. Send as Bearer token in the Authorization header. - `X-Plan-Manager-Id` header (required) — Plan manager UUID. Required on all public API requests to scope data access. ## Request ### Path parameters - `participant_id` (string, required) — Participant UUID ### Body (application/json) This endpoint expects a TeamMemberCreate. - `first_name` (string, required) - `last_name` (string, required) - `email` (string, optional, nullable) — Omit (or send null) to add a contact without portal login. Cannot be changed after create. - `role` (string, optional) — Relationship/role (e.g. Mother, Support Coordinator, Plan Nominee) - `permissions` (list of string, optional) — Permissions to grant. Accepts slugs (view_budget), labels (View Budget), or permission UUIDs. Defaults to no_access when omitted or empty. Contacts without an email must use no_access only; any other permission is rejected with 400. - `phone_number` (string, optional) - `note` (string, optional) — Internal note. Shared across participants for emailed team members; per-contact otherwise. - `secondary_email` (string, optional) - `secondary_phone_number` (string, optional) - `address_line_1` (string, optional) - `city` (string, optional) - `state` (enum, optional) - Allowed values: `ACT`, `NSW`, `NT`, `QLD`, `SA`, `TAS`, `VIC`, `WA` - `postcode` (string, optional) - `contact_priority` (enum, optional) — 1 = Primary Contact, 2 = Secondary Contact - Allowed values: `1`, `2` ## Response ### 201 Team member created - `id` (string, optional) — Stable identifier for this team member on this participant. For emailed members this is user_id; for members without an email this is pm_profile_id. - `user_id` (string, optional) - `pm_profile_id` (string, optional, nullable) - `participant_id` (string, optional) - `first_name` (string, optional) - `last_name` (string, optional) - `email` (string, optional, nullable) — Null for contacts added without an email - `role` (string, optional, nullable) - `phone_number` (string, optional, nullable) - `note` (string, optional, nullable) - `secondary_email` (string, optional, nullable) - `secondary_phone_number` (string, optional, nullable) - `address_line_1` (string, optional, nullable) - `city` (string, optional, nullable) - `state` (string, optional, nullable) - `postcode` (string, optional, nullable) - `contact_priority` (integer, optional, nullable) — 1 = Primary Contact - `permissions` (list of PermissionResponse, optional) ## Errors ### 400 Bad Request Error Invalid request parameters - `success` (boolean, optional) - `error` (string, optional) — Error type or code - `detail` (string, optional) — Human-readable error message ### 403 Forbidden Error Access denied for plan manager - `success` (boolean, optional) - `error` (string, optional) — Error type or code - `detail` (string, optional) — Human-readable error message ### 404 Not Found Error Resource not found - `success` (boolean, optional) - `error` (string, optional) — Error type or code - `detail` (string, optional) — Human-readable error message ### 409 Conflict Error Resource already exists - `success` (boolean, optional) - `error` (string, optional) — Error type or code - `detail` (string, optional) — Human-readable error message ### 429 Too Many Requests Error Rate limit exceeded. Adding a team member is limited to one request every 5 seconds per API key. - `success` (boolean, optional) - `error` (string, optional) — Error type or code - `detail` (string, optional) — Human-readable error message ### 500 Internal Server Error Internal server error - `success` (boolean, optional) - `error` (string, optional) — Error type or code - `detail` (string, optional) — Human-readable error message ## Types ### PermissionResponse A grantable team-member permission. - `id` (string, optional) — Permission UUID - `name` (string, optional) — Stable slug used in create/update payloads (e.g. view_budget, view_invoices, approve_invoices, email_statements, view_documents, no_access) - `label` (string, optional) — Friendly display name - `order` (integer, optional) — Display order ## Examples **Request** ```json { "first_name": "string", "last_name": "string" } ``` **Response** ```json { "id": "string", "user_id": "string", "pm_profile_id": "string", "participant_id": "string", "first_name": "string", "last_name": "string", "email": "string", "role": "string", "phone_number": "string", "note": "string", "secondary_email": "string", "secondary_phone_number": "string", "address_line_1": "string", "city": "string", "state": "string", "postcode": "string", "contact_priority": 1, "permissions": [ { "id": "string", "name": "string", "label": "string", "order": 1 } ] } ``` **SDK Code** ```python import requests url = "https://api.caresquareapi.com/api/public/v1/participants/participant_id/team-members" payload = { "first_name": "string", "last_name": "string" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.caresquareapi.com/api/public/v1/participants/participant_id/team-members'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"first_name":"string","last_name":"string"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.caresquareapi.com/api/public/v1/participants/participant_id/team-members" payload := strings.NewReader("{\n \"first_name\": \"string\",\n \"last_name\": \"string\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.caresquareapi.com/api/public/v1/participants/participant_id/team-members") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"first_name\": \"string\",\n \"last_name\": \"string\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.caresquareapi.com/api/public/v1/participants/participant_id/team-members") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"first_name\": \"string\",\n \"last_name\": \"string\"\n}") .asString(); ``` ```php request('POST', 'https://api.caresquareapi.com/api/public/v1/participants/participant_id/team-members', [ 'body' => '{ "first_name": "string", "last_name": "string" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.caresquareapi.com/api/public/v1/participants/participant_id/team-members"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"first_name\": \"string\",\n \"last_name\": \"string\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "first_name": "string", "last_name": "string" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.caresquareapi.com/api/public/v1/participants/participant_id/team-members")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```