Ricky logorickyDocs

Create a directory contact

POST
/knowledge/contacts

Adds a contact card the agents can send to customers.

Scope: knowledge:write.

Authorization

bearerAuth
headerAuthorizationBearer <token>

An organization API key, rky_live_…, created in Settings → API. Send it only from a server.

Header Parameters

Idempotency-Key?string

Optional. A value you choose, unique per logical write, 8–200 characters: a UUID or an ID from your system such as order-10482-ready. Retrying with the same key and body replays the first response instead of repeating the write.

Length8 <= length <= 200

Request Body

application/json
  1. body

A contact card needs a display name and a phone or an email.

display_name*string

Name shown on the contact card.

Length1 <= length <= 200
first_name?|

First name.

last_name?|

Last name.

prefix?|

Name prefix, such as Dr..

suffix?|

Name suffix.

company?|

Company.

department?|

Department.

job_title?|

Job title.

description?|

When the agents should share it.

phone?|

Phone with country code, for example +507 6000-1234.

phone_type?|null
email?|

Email.

email_type?|null

Response Body

Success.

application/json
  1. response
data*

A contact card in the knowledge directory, which agents can send to customers.

curl -X POST 'https://getricky.ai/api/v1/knowledge/contacts' \  -H 'Idempotency-Key: order-10482-ready' \  -H 'Content-Type: application/json' \  -d '{  "display_name": "Ventas Casa Nativa",  "department": "Ventas",  "phone": "+507 6000-1111",  "phone_type": "WORK",  "email": "ventas@example.com"}'
{  "data": {    "id": "a7b8c9d0-e1f2-4a3b-8c4d-5e6f7a8b9c0d",    "display_name": "Ventas Casa Nativa",    "first_name": "Valeria",    "last_name": "Ruiz",    "prefix": null,    "suffix": null,    "company": "Casa Nativa",    "department": "Ventas",    "job_title": "Gerente de ventas",    "description": "Pedidos al por mayor.",    "phone": "+50760001111",    "phone_type": "WORK",    "email": "ventas@example.com",    "email_type": "WORK"  }}