outbound

Embed

<a href="https://hermeticor.com/docs/ref-outbound"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/3a54f1ef-9d8b-4cc5-aeee-3401241a9434/social-card.svg?v=3e7ae33eec8b" alt="outbound" width="600" height="315"></a>

POSThttps://hermeticor.com/v1/outbound/prospects/import

Request body

application/json

rowsobject[]required

Show child parameters

emailstringrequired

firstNamestring

lastNamestring

titlestring

companystring

websitestring

linkedinUrlstring

countrystring

timezonestring

customFieldsobject

= {}

onExistingstring

update | skip = update

ownerRuleobject

= {"kind":"none"}

{
  "rows": [
    {
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "title": "string",
      "company": "string",
      "website": "string",
      "linkedinUrl": "string",
      "country": "string",
      "timezone": "string",
      "customFields": {}
    }
  ],
  "onExisting": "update",
  "ownerRule": {
    "kind": "none"
  }
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/prospects/import" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"rows":[{"email":"string","firstName":"string","lastName":"string","title":"string","company":"string","website":"string","linkedinUrl":"string","country":"string","timezone":"string","customFields":{}}],"onExisting":"update","ownerRule":{"kind":"none"}}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "created": 0,
  "updated": 0,
  "skipped": 0,
  "errors": [
    {
      "row": 0,
      "error": "string"
    }
  ],
  "warnings": [
    {
      "row": 0,
      "warning": "string"
    }
  ],
  "profileIds": [
    "string"
  ]
}

Schema

createdintegerrequired

updatedintegerrequired

skippedintegerrequired

errorsErrorsItem2[]required

Show child parameters

rowintegerrequired

errorstringrequired

warningsobject[]required

Show child parameters

rowintegerrequired

warningstringrequired

profileIdsstring[]required

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · POST /v1/outbound/prospects/import

POSThttps://hermeticor.com/v1/outbound/prospects/adopt

Request body

application/json

profileIdsstring[]required

{
  "profileIds": [
    "string"
  ]
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/prospects/adopt" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"profileIds":["string"]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "adopted": 0
}

Schema

adoptedintegerrequired

4XX Default Response

Same as 4XX · POST /v1/outbound/prospects/import

5XX Default Response

Same as 4XX · POST /v1/outbound/prospects/import

POSThttps://hermeticor.com/v1/outbound/dnc

Request body

application/json

emailsstring[]

= []

domainsstring[]

= []

{
  "emails": [],
  "domains": []
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/dnc" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"emails":[],"domains":[]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "suppressed": 0,
  "domainsBlocked": 0
}

Schema

suppressedintegerrequired

domainsBlockedintegerrequired

4XX Default Response

Same as 4XX · POST /v1/outbound/prospects/import

5XX Default Response

Same as 4XX · POST /v1/outbound/prospects/import

GEThttps://hermeticor.com/v1/outbound/prospects

Parameters

limitintegerquery

= 50

cursorstringquery

statusstringquery

ownerUserIdstringquery

domainstringquery

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/outbound/prospects" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "profileId": "string",
      "status": "new",
      "ownerUserId": "string",
      "companyObjectId": "string",
      "domain": "string",
      "title": "string",
      "linkedinUrl": "string",
      "website": "string",
      "lastContactedAt": "2024-01-01T00:00:00Z",
      "lastSequenceId": "string",
      "enrichment": {},
      "dealValueCents": 0,
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z",
      "profile": {
        "id": "string",
        "name": "string",
        "email": "string"
      }
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem81[]required

Show child parameters

idstringrequired

profileIdstringrequired

statusstringrequired

ownerUserIdstringrequired

companyObjectIdstringrequired

domainstringrequired

titlestringrequired

linkedinUrlstringrequired

websitestringrequired

lastContactedAtstringrequired

lastSequenceIdstringrequired

enrichmentobjectrequired

dealValueCentsinteger

createdAtstringrequired

updatedAtstringrequired

profileobjectrequired

Show child parameters

idstringrequired

namestringrequired

emailstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/outbound/prospects/import

5XX Default Response

Same as 4XX · POST /v1/outbound/prospects/import

GEThttps://hermeticor.com/v1/outbound/prospects/{profileId}

Parameters

profileIdstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/outbound/prospects/{profileId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "profileId": "string",
  "status": "new",
  "ownerUserId": "string",
  "companyObjectId": "string",
  "domain": "string",
  "title": "string",
  "linkedinUrl": "string",
  "website": "string",
  "lastContactedAt": "2024-01-01T00:00:00Z",
  "lastSequenceId": "string",
  "enrichment": {},
  "dealValueCents": 0,
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z",
  "profile": {
    "id": "string",
    "name": "string",
    "email": "string"
  }
}

Schema

idstringrequired

profileIdstringrequired

statusstringrequired

ownerUserIdstringrequired

companyObjectIdstringrequired

domainstringrequired

titlestringrequired

linkedinUrlstringrequired

websitestringrequired

lastContactedAtstringrequired

lastSequenceIdstringrequired

enrichmentobjectrequired

dealValueCentsinteger

createdAtstringrequired

updatedAtstringrequired

profileobjectrequired

Show child parameters

idstringrequired

namestringrequired

emailstringrequired

4XX Default Response

Same as 4XX · POST /v1/outbound/prospects/import

5XX Default Response

Same as 4XX · POST /v1/outbound/prospects/import

PATCHhttps://hermeticor.com/v1/outbound/prospects/{profileId}

Parameters

profileIdstringpathrequired

Request body

application/json

statusstring

ownerUserIdstring

dealValueCentsinteger

{
  "status": "new",
  "ownerUserId": "string",
  "dealValueCents": 0
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/outbound/prospects/{profileId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"new","ownerUserId":"string","dealValueCents":0}'

TypeScript

Python

PHP

Ruby

Java