POST/api/v1/contacts

Product availabilityAlgaPSAAlgaDesk

Create contact

Inherited ApiBaseController create route for contacts.

RBAC · contact

Request body

Content type: application/json · schema ContactBody

contact_kindstring

Enum: personshared_mailbox

full_namestringRequired

client_idstring <uuid>

manager_contact_idstring <uuid>Nullable

phone_numbersarray of object

default []

itemsobject

Each row needs canonical_type (work|mobile|home|fax|other) or custom_type, not both. When any rows are sent, exactly one must have is_default: true. On update, the array replaces all of the contact's phone numbers; include contact_phone_number_id to keep an existing row.

contact_phone_number_idstring <uuid>

Include to keep an existing row on update; omit for a new row.

phone_numberstringRequired

extensionstring

Digits only.

canonical_typestringNullable

Enum: workmobilehomefaxothernull

custom_typestringNullable

min length 1

is_defaultboolean

display_orderinteger

≥ 0

normalized_phone_numberstring

Read-only; ignored on write.

custom_phone_type_idstring <uuid>Nullable

Read-only; ignored on write.

created_atanyOf

Read-only; ignored on write.

anyOf (option 1)string

anyOf (option 2)string

anyOf (option 3)null

updated_atanyOf

Read-only; ignored on write.

anyOf (option 1)string

anyOf (option 2)string

anyOf (option 3)null

emailstringRequired

primary_email_canonical_typestringNullable

Enum: workpersonalbillingothernull

primary_email_custom_typestringNullable

min length 1

primary_email_custom_type_idstring <uuid>Nullable

additional_email_addressesarray of object

default []

itemsobject

Each row needs canonical_type (work|personal|billing|other) or custom_type, not both. On update, the array replaces all of the contact's additional email addresses; include contact_additional_email_address_id to keep an existing row.

contact_additional_email_address_idstring <uuid>

Include to keep an existing row on update; omit for a new row.

email_addressstringRequired

Must be a valid email address.

canonical_typestringNullable

Enum: workpersonalbillingothernull

custom_typestringNullable

min length 1

display_orderinteger

≥ 0

normalized_email_addressstring

Read-only; ignored on write.

custom_email_type_idstring <uuid>Nullable

Read-only; ignored on write.

created_atanyOf

Read-only; ignored on write.

anyOf (option 1)string

anyOf (option 2)string

anyOf (option 3)null

updated_atanyOf

Read-only; ignored on write.

anyOf (option 1)string

anyOf (option 2)string

anyOf (option 3)null

rolestring

max length 100

notesstring

is_inactiveboolean

default false

tagsarray of string

itemsstring

Response body

Success response 201 · schema ClientContactEnvelope

dataobjectRequired

contact_name_idstring <uuid>Required

full_namestringRequired

client_idstring <uuid>RequiredNullable

emailstring <email>Required

rolestringRequiredNullable

created_atstring <date-time>Required

updated_atstring <date-time>Required

is_inactivebooleanRequired

tenantstring <uuid>Required

phone_numbersarray of object

itemsobject

contact_phone_number_idstring <uuid>Required

phone_numberstringRequired

normalized_phone_numberstringRequired

canonical_typestringNullable

custom_phone_type_idstring <uuid>Nullable

custom_typestringRequiredNullable

is_defaultbooleanRequired

display_orderintegerRequired

≥ 0

additional_email_addressesarray of object

itemsobject

contact_additional_email_address_idstring <uuid>Required

email_addressstring <email>Required

normalized_email_addressstring <email>Required

canonical_typestringNullable

custom_email_type_idstring <uuid>Nullable

custom_typestringRequiredNullable

display_orderintegerRequired

≥ 0

default_phone_numberstringNullable

default_phone_typestringNullable

primary_email_canonical_typestringNullable

primary_email_custom_type_idstring <uuid>Nullable

primary_email_typestringNullable

notesstringNullable

avatarUrlstringNullable

tagsarray of string

itemsstring

client_namestringNullable

metaobject

Response codes

201

Contact created.

400

Invalid request payload.

401

API key missing/invalid or key user not found.

403

Permission denied for contact create.

500

Unexpected contact creation failure.

POST /api/v1/contacts

cURL

curl -X POST "https://algapsa.com/api/v1/contacts" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "contact_kind": "person",
  "full_name": "string",
  "client_id": "01HN2K7VRB9PQ3Y0000000000",
  "manager_contact_id": "01HN2K7VRB9PQ3Y0000000000",
  "phone_numbers": [],
  "email": "string",
  "primary_email_canonical_type": "work",
  "primary_email_custom_type": "x",
  "primary_email_custom_type_id": "01HN2K7VRB9PQ3Y0000000000",
  "additional_email_addresses": [],
  "role": "string",
  "notes": "string",
  "is_inactive": false,
  "tags": [
    "string"
  ]
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/contacts", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "contact_kind": "person",
    "full_name": "string",
    "client_id": "01HN2K7VRB9PQ3Y0000000000",
    "manager_contact_id": "01HN2K7VRB9PQ3Y0000000000",
    "phone_numbers": [],
    "email": "string",
    "primary_email_canonical_type": "work",
    "primary_email_custom_type": "x",
    "primary_email_custom_type_id": "01HN2K7VRB9PQ3Y0000000000",
    "additional_email_addresses": [],
    "role": "string",
    "notes": "string",
    "is_inactive": false,
    "tags": [
      "string"
    ]
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://algapsa.com/api/v1/contacts");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""contact_kind"": ""person"",
  ""full_name"": ""string"",
  ""client_id"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""manager_contact_id"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""phone_numbers"": [],
  ""email"": ""string"",
  ""primary_email_canonical_type"": ""work"",
  ""primary_email_custom_type"": ""x"",
  ""primary_email_custom_type_id"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""additional_email_addresses"": [],
  ""role"": ""string"",
  ""notes"": ""string"",
  ""is_inactive"": false,
  ""tags"": [
    ""string""
  ]
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

201 OK·application/json

{
  "data": {
    "contact_name_id": "01HN2K7VRB9PQ3Y0000000000",
    "full_name": "string",
    "client_id": "01HN2K7VRB9PQ3Y0000000000",
    "email": "user@example.com",
    "role": "string",
    "created_at": "2026-04-18T15:22:14Z",
    "updated_at": "2026-04-18T15:22:14Z",
    "is_inactive": false,
    "tenant": "01HN2K7VRB9PQ3Y0000000000",
    "phone_numbers": [
      {
        "contact_phone_number_id": "01HN2K7VRB9PQ3Y0000000000",
        "phone_number": "string",
        "normalized_phone_number": "string",
        "canonical_type": "string",
        "custom_phone_type_id": "01HN2K7VRB9PQ3Y0000000000",
        "custom_type": "string",
        "is_default": false,
        "display_order": 0
      }
    ],
    "additional_email_addresses": [
      {
        "contact_additional_email_address_id": "01HN2K7VRB9PQ3Y0000000000",
        "email_address": "user@example.com",
        "normalized_email_address": "user@example.com",
        "canonical_type": "string",
        "custom_email_type_id": "01HN2K7VRB9PQ3Y0000000000",
        "custom_type": "string",
        "display_order": 0
      }
    ],
    "default_phone_number": "string",
    "default_phone_type": "string",
    "primary_email_canonical_type": "string",
    "primary_email_custom_type_id": "01HN2K7VRB9PQ3Y0000000000",
    "primary_email_type": "string",
    "notes": "string",
    "avatarUrl": "string",
    "tags": [
      "string"
    ],
    "client_name": "string"
  },
  "meta": {}
}