Skip to main content
POST
/
invites:accept
Accept an invite
curl --request POST \
  --url https://api.withampersand.com/v1/invites:accept \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "invitedEmail": "<string>"
}
'
import requests

url = "https://api.withampersand.com/v1/invites:accept"

payload = { "invitedEmail": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({invitedEmail: '<string>'})
};

fetch('https://api.withampersand.com/v1/invites:accept', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.withampersand.com/v1/invites:accept",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'invitedEmail' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.withampersand.com/v1/invites:accept"

	payload := strings.NewReader("{\n  \"invitedEmail\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.withampersand.com/v1/invites:accept")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"invitedEmail\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.withampersand.com/v1/invites:accept")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"invitedEmail\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "builder": {
    "id": "builder-id-123",
    "idpProvider": "clerk",
    "idpRef": "<string>",
    "createTime": "2023-11-07T05:31:56Z",
    "firstName": "<string>",
    "lastName": "<string>",
    "fullName": "<string>",
    "primaryEmail": "<string>"
  },
  "projectRoles": {},
  "orgRole": {
    "role": "admin",
    "principalId": "builder-id-123",
    "org": {
      "id": "9f7c3e2a-61b8-4f5c-8d1a-eb24f3b05d79",
      "label": "Acme Inc",
      "defaultTeamId": "<string>",
      "createTime": "2023-11-07T05:31:56Z",
      "updateTime": "2023-11-07T05:31:56Z"
    }
  }
}
{
  "type": "urn:problem-type:exampleOrganization:exampleProblem",
  "href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
  "title": "Description of the type of problem that occurred",
  "status": 400,
  "detail": "Description of specific occurrence of the problem",
  "instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
invitedEmail
string
required

The email address that the invite was sent to

Response

Information about the current user and their organizations and projects

​
builder
Builder · object
required
​
projectRoles
object
required

A map of project IDs to project roles for the builder.

​
orgRole
object