Create person log entry

Create a person log entry using the authenticated API key tenant context

POST /v0/person_logs

Create person log entry

cURL

curl --request POST \
  --url https://api.tryarchitect.com/v0/person_logs \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "source": "<string>",
  "type": "webhook",
  "payload": {},
  "personId": "<string>",
  "email": "<string>",
  "phoneNumber": "2023-11-07T05:31:56Z",
  "linkedinProfileUrl": "<string>",
  "idempotencyKey": "<string>",
  "name": "<string>"
}
'

import requests

url = "https://api.tryarchitect.com/v0/person_logs"

payload = {
    "source": "<string>",
    "type": "webhook",
    "payload": {},
    "personId": "<string>",
    "email": "<string>",
    "phoneNumber": "2023-11-07T05:31:56Z",
    "linkedinProfileUrl": "<string>",
    "idempotencyKey": "<string>",
    "name": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    source: '<string>',
    type: 'webhook',
    payload: {},
    personId: '<string>',
    email: '<string>',
    phoneNumber: '2023-11-07T05:31:56Z',
    linkedinProfileUrl: '<string>',
    idempotencyKey: '<string>',
    name: '<string>'
  })
};

fetch('https://api.tryarchitect.com/v0/person_logs', 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.tryarchitect.com/v0/person_logs",
  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([
    'source' => '<string>',
    'type' => 'webhook',
    'payload' => [
        
    ],
    'personId' => '<string>',
    'email' => '<string>',
    'phoneNumber' => '2023-11-07T05:31:56Z',
    'linkedinProfileUrl' => '<string>',
    'idempotencyKey' => '<string>',
    'name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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.tryarchitect.com/v0/person_logs"

	payload := strings.NewReader("{\n  \"source\": \"<string>\",\n  \"type\": \"webhook\",\n  \"payload\": {},\n  \"personId\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phoneNumber\": \"2023-11-07T05:31:56Z\",\n  \"linkedinProfileUrl\": \"<string>\",\n  \"idempotencyKey\": \"<string>\",\n  \"name\": \"<string>\"\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	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.tryarchitect.com/v0/person_logs")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"source\": \"<string>\",\n  \"type\": \"webhook\",\n  \"payload\": {},\n  \"personId\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phoneNumber\": \"2023-11-07T05:31:56Z\",\n  \"linkedinProfileUrl\": \"<string>\",\n  \"idempotencyKey\": \"<string>\",\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.tryarchitect.com/v0/person_logs")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"source\": \"<string>\",\n  \"type\": \"webhook\",\n  \"payload\": {},\n  \"personId\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phoneNumber\": \"2023-11-07T05:31:56Z\",\n  \"linkedinProfileUrl\": \"<string>\",\n  \"idempotencyKey\": \"<string>\",\n  \"name\": \"<string>\"\n}"

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

201

{
  "personId": "<string>",
  "personLogId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "createdPerson": true,
  "source": "<string>",
  "type": "<string>"
}

{
  "code": "VALIDATION_ERROR",
  "detail": "body - name: Name is required; email: Invalid email address",
  "details": [
    {
      "field": "body",
      "issues": [
        {
          "code": "validation_failed",
          "message": "name: Name is required",
          "path": [
            "name"
          ]
        }
      ]
    }
  ],
  "requestId": "req_01j5k9m7n8p9q2r3s4t5v6w7x8",
  "status": 400,
  "title": "Bad Request",
  "type": "https://api.tryarchitect.com/errors/validation_error"
}

{
  "code": "UNAUTHORIZED",
  "detail": "Authentication is required",
  "requestId": "req_01j5k9m7n8p9q2r3s4t5v6w7x8",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://api.tryarchitect.com/errors/unauthorized"
}

{
  "code": "FORBIDDEN",
  "detail": "Multi-tenant API keys are not supported",
  "requestId": "req_01j5k9m7n8p9q2r3s4t5v6w7x8",
  "status": 403,
  "title": "Forbidden",
  "type": "https://api.tryarchitect.com/errors/forbidden"
}

{
  "code": "CONFLICT",
  "detail": "Default topic titles cannot be updated",
  "requestId": "req_01j5k9m7n8p9q2r3s4t5v6w7x8",
  "status": 409,
  "title": "Conflict",
  "type": "https://api.tryarchitect.com/errors/conflict"
}

{
  "code": "RATE_LIMITED",
  "detail": "Rate limit exceeded",
  "details": {
    "limit": 100,
    "remaining": 0,
    "resetTime": 1713225600000,
    "retryAfter": 60
  },
  "requestId": "req_01j5k9m7n8p9q2r3s4t5v6w7x8",
  "status": 429,
  "title": "Too Many Requests",
  "type": "https://api.tryarchitect.com/errors/rate_limited"
}

{
  "code": "INTERNAL",
  "detail": "An unexpected error occurred",
  "requestId": "req_01j5k9m7n8p9q2r3s4t5v6w7x8",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://api.tryarchitect.com/errors/internal"
}

{
  "code": "SERVICE_UNAVAILABLE",
  "detail": "The service is temporarily unavailable",
  "requestId": "req_01j5k9m7n8p9q2r3s4t5v6w7x8",
  "status": 503,
  "title": "Service Unavailable",
  "type": "https://api.tryarchitect.com/errors/service_unavailable"
}

Authorizations

x-api-key · string · header · required

API key authentication for the External Actor Gateway

Body

application/json

source · string · required

Stored person log source

Required string length: 1 - 100

Pattern: ^[a-z0-9]+(-[a-z0-9]+)*$

type · string · default: webhook · required

Kebab-case person activity type. Defaults to 'webhook' when omitted (e.g. 'contact-update')

Required string length: 1 - 100

Pattern: ^[a-z0-9]+(-[a-z0-9]+)*$

payload · object · required

Show child attributes

personId · string

Existing person ID to attach the log entry to

Minimum string length: 1

email · string

phoneNumber · string<date-time>

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

linkedinProfileUrl · string

Minimum string length: 1

idempotencyKey · string

Required string length: 1 - 255

name · string

Required string length: 1 - 255

Response

201

application/json

PersonLog created successfully

personId · string · required

The person that received the log entry

Minimum string length: 1

personLogId · string · required

The created person log entry ID

Minimum string length: 1

createdAt · string<date-time> · required

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

createdPerson · boolean · required

Whether the request auto-created a person before writing the log

source · string · required

Stored person log source

Required string length: 1 - 100

Pattern: ^[a-z0-9]+(-[a-z0-9]+)*$

type · string · required

Stored person log source

Required string length: 1 - 100

Pattern: ^[a-z0-9]+(-[a-z0-9]+)*$