Add a member to a team

Adds a Company member to a team and returns no response body.

POST https://app.upfour.io/v1/teams/{teamID}/members

A real request. Sending it changes data in your up4 account.

Authorization

AuthorizationA pls_ key. It stays in this browser tab. Needs member.write.

Path

teamIDpath · requiredPart of the request path.

Body

user_idrequired A user that is a member of the company.

More fields1

role Omitted or any other value adds the user as member. Adding someone who is already in the team changes nothing.

Headers

Idempotency-KeyheaderGenerated automatically when empty. How it works

Sent directly from your browser to https://app.upfour.io/v1. Mutating calls get an automatic Idempotency-Key when the field is empty.

Request

Responsenot sent yet

Fill in a key and press Send request (⌘↵).
The answer appears here.

scope member.write stable Idempotency-Key supported returns 201

Parameters

Field	Type	Description
`teamID` required	uuid	path parameter

Body

application/json required 2 fields

user_iduuidrequired

A user that is a member of the company.

All other fields1 fields

rolestring

Omitted or any other value adds the user as member. Adding someone who is already in the team changes nothing.

adminmemberviewer

Returns

A successful request returns 201 with no response body.

Errors

Only the errors this operation can return. Every error uses the same envelope.

Status	Code	Meaning
400	`bad_request`	The request is malformed or fails validation.
404	`not_found`	The requested resource does not exist or is outside the caller's scope.
403	`permission_denied`	The credentials do not permit this action.

Every call can also return unauthorized (401), rate_limit_exceeded (429) or internal_error (500 / 502). See Responses and errors.

curl -s -X POST "https://app.upfour.io/v1/teams/00000000-0000-4000-8000-000000000001/members" \ -H "Authorization: Bearer $UP4_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "role": "member", "user_id": "00000000-0000-4000-8000-000000000002" }'

const res = await fetch("https://app.upfour.io/v1/teams/00000000-0000-4000-8000-000000000001/members", { method: "POST", headers: { Authorization: `Bearer ${process.env.UP4_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ role: "member", user_id: "00000000-0000-4000-8000-000000000002", }), }); console.log(res.status);

import os import requests res = requests.post( "https://app.upfour.io/v1/teams/00000000-0000-4000-8000-000000000001/members", headers={"Authorization": f"Bearer {os.environ['UP4_API_KEY']}"}, json={ "role": "member", "user_id": "00000000-0000-4000-8000-000000000002", }, ) print(res.status_code)

package main import ( "fmt" "net/http" "os" "strings" ) func main() { payload := strings.NewReader(`{ "role": "member", "user_id": "00000000-0000-4000-8000-000000000002" }`) req, _ := http.NewRequest("POST", "https://app.upfour.io/v1/teams/00000000-0000-4000-8000-000000000001/members", payload) req.Header.Set("Authorization", "Bearer "+os.Getenv("UP4_API_KEY")) req.Header.Set("Content-Type", "application/json") res, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer res.Body.Close() fmt.Println(res.StatusCode) }

<?php $payload = <<<'JSON' { "role": "member", "user_id": "00000000-0000-4000-8000-000000000002" } JSON; $ch = curl_init("https://app.upfour.io/v1/teams/00000000-0000-4000-8000-000000000001/members"); curl_setopt_array($ch, [ CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => [ "Authorization: Bearer " . getenv("UP4_API_KEY"), "Content-Type: application/json", ], CURLOPT_POSTFIELDS => $payload, ]); $response = curl_exec($ch); echo curl_getinfo($ch, CURLINFO_RESPONSE_CODE), "\n"; curl_close($ch);