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"
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}{
"statusCode": 429,
"error": "Too Many Requests",
"message": "<string>",
"retryAfterSeconds": 123
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}Contacts
Import contact
Add a contact with notes and tags, or update a matching record.
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"
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}{
"statusCode": 429,
"error": "Too Many Requests",
"message": "<string>",
"retryAfterSeconds": 123
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}Save a contact in Jobin before enriching their profile or adding them to a sequence.
Choose
overwriteMode to control how matching records are updated, and autoUpdate for automatic profile updates.
You can use email for a work email address. If you send both email and workEmail, Jobin uses workEmail.
Supply tags as names or as objects with a value. Tag objects can also include iconName and color.
Import profile details only. Internal ownership, workflow, pipeline membership, sequence state, derived flags, and unknown fields are rejected. Use the dedicated pipeline, campaign and document endpoints for those actions. A supplied contact _id can replay an existing contact only within the authenticated workgroup.
Rate limit: 30 requests/minute per endpoint and workgroup. Details.Authorizations
Body
application/json
