curl --request POST \
--url https://api.journeybee.io/v1/agreement-templates/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"external_template_ref": "<string>",
"roles": [
{
"name": "<string>"
}
],
"active": true
}
'import requests
url = "https://api.journeybee.io/v1/agreement-templates/"
payload = {
"name": "<string>",
"external_template_ref": "<string>",
"roles": [{ "name": "<string>" }],
"active": True
}
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({
name: '<string>',
external_template_ref: '<string>',
roles: [{name: '<string>'}],
active: true
})
};
fetch('https://api.journeybee.io/v1/agreement-templates/', 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.journeybee.io/v1/agreement-templates/",
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([
'name' => '<string>',
'external_template_ref' => '<string>',
'roles' => [
[
'name' => '<string>'
]
],
'active' => true
]),
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.journeybee.io/v1/agreement-templates/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"external_template_ref\": \"<string>\",\n \"roles\": [\n {\n \"name\": \"<string>\"\n }\n ],\n \"active\": true\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.journeybee.io/v1/agreement-templates/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"external_template_ref\": \"<string>\",\n \"roles\": [\n {\n \"name\": \"<string>\"\n }\n ],\n \"active\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.journeybee.io/v1/agreement-templates/")
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 \"name\": \"<string>\",\n \"external_template_ref\": \"<string>\",\n \"roles\": [\n {\n \"name\": \"<string>\"\n }\n ],\n \"active\": true\n}"
response = http.request(request)
puts response.read_body{
"uuid": "<string>",
"name": "<string>",
"provider_key": "<string>",
"installation_uuid": "<string>",
"external_template_ref": "<string>",
"roles": [
{
"name": "<string>",
"kind": "partner_contact"
}
],
"active": true,
"created_at": "<string>",
"updated_at": "<string>"
}Register or update a provider template
Provider installation only (a person credential is a 403): upserts the template by the credential’s bound installation + external_template_ref. Identical payloads are a no-op; an archived template is not revived.
curl --request POST \
--url https://api.journeybee.io/v1/agreement-templates/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"external_template_ref": "<string>",
"roles": [
{
"name": "<string>"
}
],
"active": true
}
'import requests
url = "https://api.journeybee.io/v1/agreement-templates/"
payload = {
"name": "<string>",
"external_template_ref": "<string>",
"roles": [{ "name": "<string>" }],
"active": True
}
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({
name: '<string>',
external_template_ref: '<string>',
roles: [{name: '<string>'}],
active: true
})
};
fetch('https://api.journeybee.io/v1/agreement-templates/', 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.journeybee.io/v1/agreement-templates/",
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([
'name' => '<string>',
'external_template_ref' => '<string>',
'roles' => [
[
'name' => '<string>'
]
],
'active' => true
]),
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.journeybee.io/v1/agreement-templates/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"external_template_ref\": \"<string>\",\n \"roles\": [\n {\n \"name\": \"<string>\"\n }\n ],\n \"active\": true\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.journeybee.io/v1/agreement-templates/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"external_template_ref\": \"<string>\",\n \"roles\": [\n {\n \"name\": \"<string>\"\n }\n ],\n \"active\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.journeybee.io/v1/agreement-templates/")
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 \"name\": \"<string>\",\n \"external_template_ref\": \"<string>\",\n \"roles\": [\n {\n \"name\": \"<string>\"\n }\n ],\n \"active\": true\n}"
response = http.request(request)
puts response.read_body{
"uuid": "<string>",
"name": "<string>",
"provider_key": "<string>",
"installation_uuid": "<string>",
"external_template_ref": "<string>",
"roles": [
{
"name": "<string>",
"kind": "partner_contact"
}
],
"active": true,
"created_at": "<string>",
"updated_at": "<string>"
}Authorizations
API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".
Body
Response
Default Response
The provider app's name (installations.app_id -> apps.name), stamped by the server — never sent in the request.
The provider installation that owns this template (the credential's bound installation).
The provider's template id on its side; unique per (installation, ref).
Signer slots the provider declared: [{ name, kind }] with kind partner_contact, company_user or fixed.
Show child attributes
Show child attributes
The installation marks a template inactive when its roles change on the provider side.