Import contact
curl --request POST \
--url https://my.jobin.cloud/api/openapi/v1/contacts/import \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"contact": {
"_id": "<string>",
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"socialUrl": "<string>",
"email": "[email protected]",
"workEmail": "[email protected]",
"privateEmail": "[email protected]",
"otherEmails": [
"[email protected]"
],
"workPhone": "<string>",
"privatePhone": "<string>",
"otherPhones": [
"<string>"
],
"workMobilePhone": "<string>",
"privateMobilePhone": "<string>",
"otherMobilePhones": [
"<string>"
],
"summary": "<string>",
"tags": [
"<string>"
],
"customFieldList": [
{
"fieldName": "<string>",
"_id": "<string>",
"value": "<string>",
"customFieldDefinitionId": "<string>",
"textValue": "<string>",
"numberValue": 123,
"dateValue": "2023-11-07T05:31:56Z",
"listValue": "<string>"
}
]
}
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contact: {
_id: '<string>',
firstName: '<string>',
middleName: '<string>',
lastName: '<string>',
socialUrl: '<string>',
email: '[email protected]',
workEmail: '[email protected]',
privateEmail: '[email protected]',
otherEmails: ['[email protected]'],
workPhone: '<string>',
privatePhone: '<string>',
otherPhones: ['<string>'],
workMobilePhone: '<string>',
privateMobilePhone: '<string>',
otherMobilePhones: ['<string>'],
summary: '<string>',
tags: ['<string>'],
customFieldList: [
{
fieldName: '<string>',
_id: '<string>',
value: '<string>',
customFieldDefinitionId: '<string>',
textValue: '<string>',
numberValue: 123,
dateValue: '2023-11-07T05:31:56Z',
listValue: '<string>'
}
]
}
})
};
fetch('https://my.jobin.cloud/api/openapi/v1/contacts/import', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://my.jobin.cloud/api/openapi/v1/contacts/import"
payload = { "contact": {
"_id": "<string>",
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"socialUrl": "<string>",
"email": "[email protected]",
"workEmail": "[email protected]",
"privateEmail": "[email protected]",
"otherEmails": ["[email protected]"],
"workPhone": "<string>",
"privatePhone": "<string>",
"otherPhones": ["<string>"],
"workMobilePhone": "<string>",
"privateMobilePhone": "<string>",
"otherMobilePhones": ["<string>"],
"summary": "<string>",
"tags": ["<string>"],
"customFieldList": [
{
"fieldName": "<string>",
"_id": "<string>",
"value": "<string>",
"customFieldDefinitionId": "<string>",
"textValue": "<string>",
"numberValue": 123,
"dateValue": "2023-11-07T05:31:56Z",
"listValue": "<string>"
}
]
} }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)$headers=@{}
$headers.Add("x-api-key", "<api-key>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://my.jobin.cloud/api/openapi/v1/contacts/import' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"contact": {
"_id": "<string>",
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"socialUrl": "<string>",
"email": "[email protected]",
"workEmail": "[email protected]",
"privateEmail": "[email protected]",
"otherEmails": [
"[email protected]"
],
"workPhone": "<string>",
"privatePhone": "<string>",
"otherPhones": [
"<string>"
],
"workMobilePhone": "<string>",
"privateMobilePhone": "<string>",
"otherMobilePhones": [
"<string>"
],
"summary": "<string>",
"tags": [
"<string>"
],
"customFieldList": [
{
"fieldName": "<string>",
"_id": "<string>",
"value": "<string>",
"customFieldDefinitionId": "<string>",
"textValue": "<string>",
"numberValue": 123,
"dateValue": "2023-11-07T05:31:56Z",
"listValue": "<string>"
}
]
}
}'{
"contactId": "<string>",
"autoUpdate": true,
"overwriteMode": "overwriteWithNewest"
}{
"statusCode": 429,
"error": "Too Many Requests",
"message": "<string>",
"retryAfterSeconds": 123
}Contacts
Import Contact
Import one Jobin contact with notes, tags, duplicate overwrite mode, and optional automatic update behavior.
POST
/
contacts
/
import
Import contact
curl --request POST \
--url https://my.jobin.cloud/api/openapi/v1/contacts/import \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"contact": {
"_id": "<string>",
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"socialUrl": "<string>",
"email": "[email protected]",
"workEmail": "[email protected]",
"privateEmail": "[email protected]",
"otherEmails": [
"[email protected]"
],
"workPhone": "<string>",
"privatePhone": "<string>",
"otherPhones": [
"<string>"
],
"workMobilePhone": "<string>",
"privateMobilePhone": "<string>",
"otherMobilePhones": [
"<string>"
],
"summary": "<string>",
"tags": [
"<string>"
],
"customFieldList": [
{
"fieldName": "<string>",
"_id": "<string>",
"value": "<string>",
"customFieldDefinitionId": "<string>",
"textValue": "<string>",
"numberValue": 123,
"dateValue": "2023-11-07T05:31:56Z",
"listValue": "<string>"
}
]
}
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contact: {
_id: '<string>',
firstName: '<string>',
middleName: '<string>',
lastName: '<string>',
socialUrl: '<string>',
email: '[email protected]',
workEmail: '[email protected]',
privateEmail: '[email protected]',
otherEmails: ['[email protected]'],
workPhone: '<string>',
privatePhone: '<string>',
otherPhones: ['<string>'],
workMobilePhone: '<string>',
privateMobilePhone: '<string>',
otherMobilePhones: ['<string>'],
summary: '<string>',
tags: ['<string>'],
customFieldList: [
{
fieldName: '<string>',
_id: '<string>',
value: '<string>',
customFieldDefinitionId: '<string>',
textValue: '<string>',
numberValue: 123,
dateValue: '2023-11-07T05:31:56Z',
listValue: '<string>'
}
]
}
})
};
fetch('https://my.jobin.cloud/api/openapi/v1/contacts/import', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://my.jobin.cloud/api/openapi/v1/contacts/import"
payload = { "contact": {
"_id": "<string>",
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"socialUrl": "<string>",
"email": "[email protected]",
"workEmail": "[email protected]",
"privateEmail": "[email protected]",
"otherEmails": ["[email protected]"],
"workPhone": "<string>",
"privatePhone": "<string>",
"otherPhones": ["<string>"],
"workMobilePhone": "<string>",
"privateMobilePhone": "<string>",
"otherMobilePhones": ["<string>"],
"summary": "<string>",
"tags": ["<string>"],
"customFieldList": [
{
"fieldName": "<string>",
"_id": "<string>",
"value": "<string>",
"customFieldDefinitionId": "<string>",
"textValue": "<string>",
"numberValue": 123,
"dateValue": "2023-11-07T05:31:56Z",
"listValue": "<string>"
}
]
} }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)$headers=@{}
$headers.Add("x-api-key", "<api-key>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://my.jobin.cloud/api/openapi/v1/contacts/import' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"contact": {
"_id": "<string>",
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"socialUrl": "<string>",
"email": "[email protected]",
"workEmail": "[email protected]",
"privateEmail": "[email protected]",
"otherEmails": [
"[email protected]"
],
"workPhone": "<string>",
"privatePhone": "<string>",
"otherPhones": [
"<string>"
],
"workMobilePhone": "<string>",
"privateMobilePhone": "<string>",
"otherMobilePhones": [
"<string>"
],
"summary": "<string>",
"tags": [
"<string>"
],
"customFieldList": [
{
"fieldName": "<string>",
"_id": "<string>",
"value": "<string>",
"customFieldDefinitionId": "<string>",
"textValue": "<string>",
"numberValue": 123,
"dateValue": "2023-11-07T05:31:56Z",
"listValue": "<string>"
}
]
}
}'{
"contactId": "<string>",
"autoUpdate": true,
"overwriteMode": "overwriteWithNewest"
}{
"statusCode": 429,
"error": "Too Many Requests",
"message": "<string>",
"retryAfterSeconds": 123
}Use this endpoint when an integration needs to create or upsert one contact before enrichment, timeline download, or sequence assignment.
The
email field is a convenience alias for workEmail. If both are present, workEmail wins. String tags are normalized to { value }, while object tags may include iconName and color.Authorizations
Primary public authentication method. Create keys in Jobin.cloud under Workgroups > Integrations > Custom integration.
Body
application/json
Contact fields accepted by POST /contacts/import. Additional JSON properties are accepted and passed into the existing contact import path for supported Jobin contact fields.
Show child attributes
Show child attributes
Maximum array length:
25Required string length:
1 - 4096When true, the existing import path schedules automatic enrichment/update behavior for the contact.
Duplicate-handling mode used by the existing import service.
Available options:
overwriteWithNewest, alwaysKeepOriginalOnOverwrite, askBeforeOverwriting 