אנשי קשר

נקודות קצה לניהול אנשי קשר.

רשימת אנשי קשר get

שליפת רשימה עם עימוד.

https://your-company.example.com/api/contacts

כותרות חובה

פרמטר סוג תיאור
Accept חובה string `application/json`
Content-Type חובה string `application/json` (בבקשות עם גוף)
Authorization חובה string `Bearer {token}`

פרמטרי שאילתה

פרמטר סוג תיאור
page אופציונלי integer מספר עמוד. ברירת מחדל: 1.
per_page אופציונלי integer גודל עמוד (עד 100 ברוב המשאבים). ברירת מחדל: 15.
q אופציונלי string מחרוזת חיפוש חופשית.
order אופציונלי string מיון. דוגמה: `created_at` או `created_at|desc`.
select אופציונלי string בחירת שדות. דוגמה: `id;first_name;email`.
with אופציונלי string טעינת יחסים (eager load).

שליפת איש קשר get

שליפת רשומה בודדת לפי מזהה.

https://your-company.example.com/api/contacts/{contact}

כותרות חובה

פרמטר סוג תיאור
Accept חובה string `application/json`
Content-Type חובה string `application/json` (בבקשות עם גוף)
Authorization חובה string `Bearer {token}`

פרמטרים בנתיב

פרמטר סוג תיאור
contact חובה integer מזהה הרשומה.

יצירת איש קשר post

יצירת רשומה חדשה. תשובה מוצלחת מחזירה סטטוס 201.

https://your-company.example.com/api/contacts

כותרות חובה

פרמטר סוג תיאור
Accept חובה string `application/json`
Content-Type חובה string `application/json` (בבקשות עם גוף)
Authorization חובה string `Bearer {token}`

פרמטרים בגוף הבקשה

פרמטר סוג תיאור
first_name חובה string שם פרטי.
last_name אופציונלי string שם משפחה.
email אופציונלי string אימייל ייחודי.
phones אופציונלי array מערך `{number, type}` כאשר `type` הוא `mobile` / `work` / `other`.
job_title אופציונלי string תפקיד.
user_id אופציונלי integer מזהה בעלים.
source_id אופציונלי integer מקור ליד.
country_id אופציונלי integer מדינה.
street אופציונלי string רחוב.
city אופציונלי string עיר.
state אופציונלי string מחוז / מדינה.
postal_code אופציונלי string מיקוד.
companies אופציונלי array מזהי חברות לשיוך.
deals אופציונלי array מזהי עסקאות לשיוך.
tags אופציונלי array שמות תגיות.
{custom_field_id} אופציונלי mixed שדות מותאמים — ראו מבוא ל-API.

דוגמת גוף בקשה

{
    "first_name": "ישראל",
    "last_name": "ישראלי",
    "email": "israel@example.com",
    "phones": [
        {
            "number": "+972501234567",
            "type": "mobile"
        },
        {
            "number": "+97239123456",
            "type": "work"
        }
    ],
    "source_id": 1,
    "user_id": 1,
    "companies": [
        1
    ],
    "tags": [
        "VIP"
    ]
}

עדכון איש קשר put

עדכון חלקי או מלא של רשומה קיימת.

https://your-company.example.com/api/contacts/{contact}

כותרות חובה

פרמטר סוג תיאור
Accept חובה string `application/json`
Content-Type חובה string `application/json` (בבקשות עם גוף)
Authorization חובה string `Bearer {token}`

פרמטרים בנתיב

פרמטר סוג תיאור
contact חובה integer מזהה הרשומה.

פרמטרים בגוף הבקשה

פרמטר סוג תיאור
first_name אופציונלי string שם פרטי.
last_name אופציונלי string שם משפחה.
email אופציונלי string אימייל ייחודי.
phones אופציונלי array מערך `{number, type}` כאשר `type` הוא `mobile` / `work` / `other`.
job_title אופציונלי string תפקיד.
user_id אופציונלי integer מזהה בעלים.
source_id אופציונלי integer מקור ליד.
country_id אופציונלי integer מדינה.
street אופציונלי string רחוב.
city אופציונלי string עיר.
state אופציונלי string מחוז / מדינה.
postal_code אופציונלי string מיקוד.
companies אופציונלי array מזהי חברות לשיוך.
deals אופציונלי array מזהי עסקאות לשיוך.
tags אופציונלי array שמות תגיות.
{custom_field_id} אופציונלי mixed שדות מותאמים — ראו מבוא ל-API.

מחיקת איש קשר delete

מחיקה רכה. תשובה מוצלחת: 204 No Content.

https://your-company.example.com/api/contacts/{contact}

כותרות חובה

פרמטר סוג תיאור
Accept חובה string `application/json`
Content-Type חובה string `application/json` (בבקשות עם גוף)
Authorization חובה string `Bearer {token}`

פרמטרים בנתיב

פרמטר סוג תיאור
contact חובה integer מזהה הרשומה.

צירוף שיוכים לאיש קשר put

https://your-company.example.com/api/associations/contacts/{contact}

כותרות חובה

פרמטר סוג תיאור
Accept חובה string `application/json`
Content-Type חובה string `application/json` (בבקשות עם גוף)
Authorization חובה string `Bearer {token}`

פרמטרים בנתיב

פרמטר סוג תיאור
contact חובה integer מזהה הרשומה.

פרמטרים בגוף הבקשה

פרמטר סוג תיאור
companies אופציונלי array מערך מזהים לשיוך. יש לספק לפחות משאב אחד.
deals אופציונלי array מערך מזהים לשיוך. יש לספק לפחות משאב אחד.
activities אופציונלי array מערך מזהים לשיוך. יש לספק לפחות משאב אחד.
documents אופציונלי array מערך מזהים לשיוך. יש לספק לפחות משאב אחד.

דוגמת גוף בקשה

{
    "companies": [
        1
    ],
    "deals": [
        2
    ],
    "activities": [
        3
    ],
    "documents": [
        4
    ]
}
יש לספק לפחות משאב אחד בגוף הבקשה.

ניתוק שיוכים מאיש קשר delete

https://your-company.example.com/api/associations/contacts/{contact}

כותרות חובה

פרמטר סוג תיאור
Accept חובה string `application/json`
Content-Type חובה string `application/json` (בבקשות עם גוף)
Authorization חובה string `Bearer {token}`

פרמטרים בנתיב

פרמטר סוג תיאור
contact חובה integer מזהה הרשומה.

פרמטרים בגוף הבקשה

פרמטר סוג תיאור
companies אופציונלי array מערך מזהים לשיוך. יש לספק לפחות משאב אחד.
deals אופציונלי array מערך מזהים לשיוך. יש לספק לפחות משאב אחד.
activities אופציונלי array מערך מזהים לשיוך. יש לספק לפחות משאב אחד.
documents אופציונלי array מערך מזהים לשיוך. יש לספק לפחות משאב אחד.
יש לספק לפחות משאב אחד בגוף הבקשה.

סנכרון שיוכים לאיש קשר post

https://your-company.example.com/api/associations/contacts/{contact}

כותרות חובה

פרמטר סוג תיאור
Accept חובה string `application/json`
Content-Type חובה string `application/json` (בבקשות עם גוף)
Authorization חובה string `Bearer {token}`

פרמטרים בנתיב

פרמטר סוג תיאור
contact חובה integer מזהה הרשומה.

פרמטרים בגוף הבקשה

פרמטר סוג תיאור
companies אופציונלי array מערך מזהים לשיוך. יש לספק לפחות משאב אחד.
deals אופציונלי array מערך מזהים לשיוך. יש לספק לפחות משאב אחד.
activities אופציונלי array מערך מזהים לשיוך. יש לספק לפחות משאב אחד.
documents אופציונלי array מערך מזהים לשיוך. יש לספק לפחות משאב אחד.
סנכרון מלא: מערך ריק למשאב מנתק את כל השיוכים של אותו סוג.

© 2026 BeCRM