Skip to main content
POST
Create a link

Authorizations

Authorization
string
header
required

nia_sk_...

Headers

Idempotency-Key
string
required

Required. Kept 24 hours with the hash of the body: a retry with the same key returns the first answer, and the same key with a different body returns 409 conflict.

Required string length: 1 - 256

Body

application/json
organization
Handle · object
required

An identifier of a subject in some channel or system: a phone, an e-mail, a CRM id.

person
Handle · object
required

An identifier of a subject in some channel or system: a phone, an e-mail, a CRM id.

role
string
required

buyer, driver, broker, technical_contact, owner...

Required string length: 1 - 256
can_see_contacts
boolean
default:false
method
enum<string>
default:declared
Available options:
system_import,
co_occurrence,
declared,
login
valid_from
string<date-time> | null
valid_to
string<date-time> | null

Response

The link.

can_see_contacts
boolean
required
org_handle_id
string<uuid>
required
person_handle_id
string<uuid>
required
role
string
required
valid_from
string<date-time>
required
valid_to
string<date-time> | null