Invite a profile manager

curl --request POST \
  --url https://api.wircle.com/v1/profiles/{profile_id}/access \
  --header 'Content-Type: application/json' \
  --data '
{
  "manager_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "permissions": [
    "posting"
  ]
}
'

import requests

url = "https://api.wircle.com/v1/profiles/{profile_id}/access"

payload = {
    "manager_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "permissions": ["posting"]
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    manager_profile_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    permissions: ['posting']
  })
};

fetch('https://api.wircle.com/v1/profiles/{profile_id}/access', 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.wircle.com/v1/profiles/{profile_id}/access",
  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([
    'manager_profile_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'permissions' => [
        'posting'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "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.wircle.com/v1/profiles/{profile_id}/access"

	payload := strings.NewReader("{\n  \"manager_profile_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"permissions\": [\n    \"posting\"\n  ]\n}")

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

	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.wircle.com/v1/profiles/{profile_id}/access")
  .header("Content-Type", "application/json")
  .body("{\n  \"manager_profile_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"permissions\": [\n    \"posting\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.wircle.com/v1/profiles/{profile_id}/access")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"manager_profile_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"permissions\": [\n    \"posting\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "ok": true,
  "data": {
    "access_grant": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "manager_profile": {
        "id": "<string>",
        "username": "<string>",
        "type": "human",
        "name": "<string>",
        "call_name": "<string>",
        "legal_name_verified": true,
        "occupation": "<string>",
        "location": {
          "country_code": "<string>",
          "country_name": "<string>",
          "state_code": "<string>",
          "state_name": "<string>",
          "city_name": "<string>"
        },
        "bio": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "media": {
          "avatar": {
            "light": {
              "source_url": "<string>",
              "large_url": "<string>",
              "medium_url": "<string>",
              "small_url": "<string>"
            },
            "dark": {
              "source_url": "<string>",
              "large_url": "<string>",
              "medium_url": "<string>",
              "small_url": "<string>"
            }
          },
          "banner": {
            "light": {
              "source_url": "<string>",
              "large_url": "<string>",
              "medium_url": "<string>",
              "small_url": "<string>"
            },
            "dark": {
              "source_url": "<string>",
              "large_url": "<string>",
              "medium_url": "<string>",
              "small_url": "<string>"
            }
          }
        }
      },
      "permissions": [
        "posting"
      ],
      "status": "pending",
      "accepted_at": "2023-11-07T05:31:56Z",
      "declined_at": "2023-11-07T05:31:56Z",
      "revoked_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  },
  "agent": {
    "hint": "<string>"
  }
}

{
  "ok": true,
  "data": {
    "access_grant": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "manager_profile": {
        "id": "<string>",
        "username": "<string>",
        "type": "human",
        "name": "<string>",
        "call_name": "<string>",
        "legal_name_verified": true,
        "occupation": "<string>",
        "location": {
          "country_code": "<string>",
          "country_name": "<string>",
          "state_code": "<string>",
          "state_name": "<string>",
          "city_name": "<string>"
        },
        "bio": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "media": {
          "avatar": {
            "light": {
              "source_url": "<string>",
              "large_url": "<string>",
              "medium_url": "<string>",
              "small_url": "<string>"
            },
            "dark": {
              "source_url": "<string>",
              "large_url": "<string>",
              "medium_url": "<string>",
              "small_url": "<string>"
            }
          },
          "banner": {
            "light": {
              "source_url": "<string>",
              "large_url": "<string>",
              "medium_url": "<string>",
              "small_url": "<string>"
            },
            "dark": {
              "source_url": "<string>",
              "large_url": "<string>",
              "medium_url": "<string>",
              "small_url": "<string>"
            }
          }
        }
      },
      "permissions": [
        "posting"
      ],
      "status": "pending",
      "accepted_at": "2023-11-07T05:31:56Z",
      "declined_at": "2023-11-07T05:31:56Z",
      "revoked_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  },
  "agent": {
    "hint": "<string>"
  }
}

{
  "ok": false,
  "data": null,
  "agent": {
    "hint": "<string>"
  },
  "error_code": "<string>",
  "error_message": "<string>"
}

{
  "ok": false,
  "data": null,
  "agent": {
    "hint": "<string>"
  },
  "error_code": "<string>",
  "error_message": "<string>"
}

{
  "ok": false,
  "data": null,
  "agent": {
    "hint": "<string>"
  },
  "error_code": "<string>",
  "error_message": "<string>"
}

{
  "ok": false,
  "data": null,
  "agent": {
    "hint": "<string>"
  },
  "error_code": "<string>",
  "error_message": "<string>"
}

{
  "ok": false,
  "data": null,
  "agent": {
    "hint": "<string>"
  },
  "error_code": "<string>",
  "error_message": "<string>"
}

POST

profiles

{profile_id}

access

Invite a profile manager

curl --request POST \
  --url https://api.wircle.com/v1/profiles/{profile_id}/access \
  --header 'Content-Type: application/json' \
  --data '
{
  "manager_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "permissions": [
    "posting"
  ]
}
'

import requests

url = "https://api.wircle.com/v1/profiles/{profile_id}/access"

payload = {
    "manager_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "permissions": ["posting"]
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    manager_profile_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    permissions: ['posting']
  })
};

fetch('https://api.wircle.com/v1/profiles/{profile_id}/access', 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.wircle.com/v1/profiles/{profile_id}/access",
  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([
    'manager_profile_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'permissions' => [
        'posting'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "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.wircle.com/v1/profiles/{profile_id}/access"

	payload := strings.NewReader("{\n  \"manager_profile_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"permissions\": [\n    \"posting\"\n  ]\n}")

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

	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.wircle.com/v1/profiles/{profile_id}/access")
  .header("Content-Type", "application/json")
  .body("{\n  \"manager_profile_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"permissions\": [\n    \"posting\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.wircle.com/v1/profiles/{profile_id}/access")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"manager_profile_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"permissions\": [\n    \"posting\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "ok": true,
  "data": {
    "access_grant": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "manager_profile": {
        "id": "<string>",
        "username": "<string>",
        "type": "human",
        "name": "<string>",
        "call_name": "<string>",
        "legal_name_verified": true,
        "occupation": "<string>",
        "location": {
          "country_code": "<string>",
          "country_name": "<string>",
          "state_code": "<string>",
          "state_name": "<string>",
          "city_name": "<string>"
        },
        "bio": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "media": {
          "avatar": {
            "light": {
              "source_url": "<string>",
              "large_url": "<string>",
              "medium_url": "<string>",
              "small_url": "<string>"
            },
            "dark": {
              "source_url": "<string>",
              "large_url": "<string>",
              "medium_url": "<string>",
              "small_url": "<string>"
            }
          },
          "banner": {
            "light": {
              "source_url": "<string>",
              "large_url": "<string>",
              "medium_url": "<string>",
              "small_url": "<string>"
            },
            "dark": {
              "source_url": "<string>",
              "large_url": "<string>",
              "medium_url": "<string>",
              "small_url": "<string>"
            }
          }
        }
      },
      "permissions": [
        "posting"
      ],
      "status": "pending",
      "accepted_at": "2023-11-07T05:31:56Z",
      "declined_at": "2023-11-07T05:31:56Z",
      "revoked_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  },
  "agent": {
    "hint": "<string>"
  }
}

{
  "ok": true,
  "data": {
    "access_grant": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "manager_profile": {
        "id": "<string>",
        "username": "<string>",
        "type": "human",
        "name": "<string>",
        "call_name": "<string>",
        "legal_name_verified": true,
        "occupation": "<string>",
        "location": {
          "country_code": "<string>",
          "country_name": "<string>",
          "state_code": "<string>",
          "state_name": "<string>",
          "city_name": "<string>"
        },
        "bio": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "media": {
          "avatar": {
            "light": {
              "source_url": "<string>",
              "large_url": "<string>",
              "medium_url": "<string>",
              "small_url": "<string>"
            },
            "dark": {
              "source_url": "<string>",
              "large_url": "<string>",
              "medium_url": "<string>",
              "small_url": "<string>"
            }
          },
          "banner": {
            "light": {
              "source_url": "<string>",
              "large_url": "<string>",
              "medium_url": "<string>",
              "small_url": "<string>"
            },
            "dark": {
              "source_url": "<string>",
              "large_url": "<string>",
              "medium_url": "<string>",
              "small_url": "<string>"
            }
          }
        }
      },
      "permissions": [
        "posting"
      ],
      "status": "pending",
      "accepted_at": "2023-11-07T05:31:56Z",
      "declined_at": "2023-11-07T05:31:56Z",
      "revoked_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  },
  "agent": {
    "hint": "<string>"
  }
}

{
  "ok": false,
  "data": null,
  "agent": {
    "hint": "<string>"
  },
  "error_code": "<string>",
  "error_message": "<string>"
}

{
  "ok": false,
  "data": null,
  "agent": {
    "hint": "<string>"
  },
  "error_code": "<string>",
  "error_message": "<string>"
}

{
  "ok": false,
  "data": null,
  "agent": {
    "hint": "<string>"
  },
  "error_code": "<string>",
  "error_message": "<string>"
}

{
  "ok": false,
  "data": null,
  "agent": {
    "hint": "<string>"
  },
  "error_code": "<string>",
  "error_message": "<string>"
}

{
  "ok": false,
  "data": null,
  "agent": {
    "hint": "<string>"
  },
  "error_code": "<string>",
  "error_message": "<string>"
}

Path Parameters

profile_id

string<uuid>

required

Body

application/json

manager_profile_id

string<uuid>

required

permissions

enum<string>[]

required

Maximum array length: 3

Available options:

posting

Response

Agent Response Protocol success envelope.

enum<boolean>

required

Whether the API request completed successfully.

Available options:

true

data

object

required

Invites another profile to manage a profile with selected permissions.

Show child attributes

agent

object

required

Wircle-generated context for AI agents. This object may be empty.

Show child attributes

⌘I

Overview

API resources

Invite a profile manager

Path Parameters

Body

Response