Associations entre fiches

Découvrir l’autre côté#

Une association porte le nom de la ressource cible. Consultez associations dans /resources/{resource} avant de construire une relation. Les ressources autorisées par la clé doivent inclure source et cible, et le propriétaire doit pouvoir accéder aux deux fiches.

Lire, relier et délier#

GET /{resource}/{id}/{association} liste les liens. PUT /{resource}/{id}/{association}/{target_id} crée ou modifie un lien avec un objet de champs facultatif. Une création renvoie 201 ; un lien existant renvoie 200. DELETE sur le même chemin cible retire le lien, n’accepte pas de corps et renvoie 404 s’il n’existait pas. PUT et DELETE acceptent Idempotency-Key.

read -r -p 'Company id: ' COMPANY_ID
read -r -p 'Contact id: ' CONTACT_ID
read -r -p 'Unique link operation key: ' LINK_KEY
curl --fail-with-body --request PUT "$SQUARIO_API_BASE/companies/$COMPANY_ID/contacts/$CONTACT_ID" \
  --header "Authorization: Bearer $SQUARIO_API_KEY" \
  --header 'Content-Type: application/json' \
  --header "Idempotency-Key: $LINK_KEY" \
  --data '{"job_title":"Operations lead","is_primary":true}'

curl --fail-with-body "$SQUARIO_API_BASE/companies/$COMPANY_ID/contacts" \
  --header "Authorization: Bearer $SQUARIO_API_KEY"

read -r -p 'Unique unlink operation key: ' UNLINK_KEY
curl --fail-with-body --request DELETE "$SQUARIO_API_BASE/companies/$COMPANY_ID/contacts/$CONTACT_ID" \
  --header "Authorization: Bearer $SQUARIO_API_KEY" \
  --header "Idempotency-Key: $UNLINK_KEY"

L’emploi suit ses propres règles#

Les liens entreprise/contact acceptent job_title, department, role_label, role_description, decision_power, buying_role, is_primary, is_decision_maker, is_billing_contact, is_technical_contact, started_at et notes. Consultez la référence pour leurs types et options.

• Un nouveau lien a is_primary à false par défaut. Le rendre principal retire ce statut à l’entreprise principale précédente du contact.
• Omettre is_primary sur un lien existant conserve sa valeur.
• DELETE termine l’emploi à la date du jour et retire son statut principal. Les liens terminés disparaissent de la liste.
• Supprimer le lien vers l’affaire principale d’un projet renvoie 409 ; modifiez d’abord cette relation principale dans l’application.

Comprendre une réponse de lien#

Chaque lien expose les deux identifiants de fiche, les champs autorisés et les horodatages, sans l’identifiant propre à la table de liaison, l’auteur ni les métadonnées internes. Les listes contiennent data et meta avec page, page_size et has_more, dans l’ordre chronologique, sans total. Les pages de liens contiennent 100 éléments par défaut et acceptent 1–100. Les champs masqués sont null, y compris les indicateurs booléens ; un champ booléen en PUT exige toujours un booléen.