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>

GEThttps://hermeticor.com/v1/outbound/mailbox-tags

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "tag": "string",
      "mailboxes": 0,
      "color": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

tagstringrequired

mailboxesintegerrequired

colorstringrequired

nextCursorstringrequired

4XX Default Response

Example

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

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · GET /v1/outbound/mailbox-tags

POSThttps://hermeticor.com/v1/outbound/mailbox-tags/assign

Request body

application/json

connectionIdsstring[]required

addstring[]

= []

removestring[]

= []

{
  "connectionIds": [
    "string"
  ],
  "add": [],
  "remove": []
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/mailbox-tags/assign" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"connectionIds":["string"],"add":[],"remove":[]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "done": 0,
  "failed": [
    {
      "id": "string",
      "error": "string"
    }
  ]
}

Schema

doneintegerrequired

failedFailedItem2[]required

Show child parameters

idstringrequired

errorstringrequired

4XX Default Response

Same as 4XX · GET /v1/outbound/mailbox-tags

5XX Default Response

Same as 4XX · GET /v1/outbound/mailbox-tags

POSThttps://hermeticor.com/v1/sender-pools/{id}/attach-by-tag

Parameters

idstringpathrequired

Request body

application/json

tagsstring[]required

modestring

add | replace = add

{
  "tags": [
    "string"
  ],
  "mode": "add"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/sender-pools/{id}/attach-by-tag" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tags":["string"],"mode":"add"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "name": "string",
  "channel": "email",
  "strategy": "round_robin",
  "members": [
    {
      "connectionId": "string",
      "senderIdentityId": null,
      "weight": 1
    }
  ],
  "matchProvider": true
}

Schema

idstringrequired

namestringrequired

channelstringrequired

email | sms | whatsapp | push | postcard

strategystringrequired

round_robin | weighted | least_used | sticky_per_recipient

membersMembersItem[]required

Show child parameters

connectionIdstringrequired

senderIdentityIdstringrequired

= null

weightintegerrequired

= 1

matchProviderbooleanrequired

4XX Default Response

Same as 4XX · GET /v1/outbound/mailbox-tags

5XX Default Response

Same as 4XX · GET /v1/outbound/mailbox-tags

POSThttps://hermeticor.com/v1/outbound/sequences/{id}/reallocate-mailboxes

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/sequences/{id}/reallocate-mailboxes" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "moved": 0,
  "kept": 0
}

Schema

movedintegerrequired

keptintegerrequired

4XX Default Response

Same as 4XX · GET /v1/outbound/mailbox-tags

5XX Default Response

Same as 4XX · GET /v1/outbound/mailbox-tags

POSThttps://hermeticor.com/v1/outbound/sequences/{id}/prospects/{profileId}/mailbox

Parameters

idstringpathrequired

profileIdstringpathrequired

Request body

application/json

connectionIdstringrequired

{
  "connectionId": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/sequences/{id}/prospects/{profileId}/mailbox" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"connectionId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · GET /v1/outbound/mailbox-tags

5XX Default Response

Same as 4XX · GET /v1/outbound/mailbox-tags

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

Parameters

limitintegerquery

= 50

cursorstringquery

statusstringquery

ownerUserIdstringquery

qstringquery

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "domain": "string",
      "name": "string",
      "industry": "string",
      "sizeBand": "string",
      "country": "string",
      "website": "string",
      "ownerUserId": "string",
      "status": "new",
      "notes": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z",
      "contacts": 0,
      "replied": 0,
      "interested": 0,
      "activeInSequence": 0
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem127[]required

Show child parameters

idstringrequired

domainstringrequired

namestringrequired

industrystringrequired

sizeBandstringrequired

countrystringrequired

websitestringrequired

ownerUserIdstringrequired

statusstringrequired

notesstringrequired

createdAtstringrequired

updatedAtstringrequired

contactsintegerrequired

repliedintegerrequired

interestedintegerrequired

activeInSequenceintegerrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/outbound/mailbox-tags

5XX Default Response

Same as 4XX · GET /v1/outbound/mailbox-tags

POSThttps://hermeticor.com/v1/outbound/accounts/backfill

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/accounts/backfill" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "linked": 0
}

Schema

linkedintegerrequired

4XX Default Response

Same as 4XX · GET /v1/outbound/mailbox-tags

5XX Default Response

Same as 4XX · GET /v1/outbound/mailbox-tags

GEThttps://hermeticor.com/v1/outbound/accounts/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "domain": "string",
  "name": "string",
  "industry": "string",
  "sizeBand": "string",
  "country": "string",
  "website": "string",
  "ownerUserId": "string",
  "status": "new",
  "notes": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z",
  "contacts": 0,
  "replied": 0,
  "interested": 0,
  "activeInSequence": 0
}

Schema

idstringrequired

domainstringrequired

namestringrequired

industrystringrequired

sizeBandstringrequired

countrystringrequired

websitestringrequired

ownerUserIdstringrequired

statusstringrequired

notesstringrequired

createdAtstringrequired

updatedAtstringrequired

contactsintegerrequired

repliedintegerrequired

interestedintegerrequired

activeInSequenceintegerrequired

4XX Default Response

Same as 4XX · GET /v1/outbound/mailbox-tags

5XX Default Response

Same as 4XX · GET /v1/outbound/mailbox-tags

PATCHhttps://hermeticor.com/v1/outbound/accounts/{id}

Parameters

idstringpathrequired

Request body

application/json

namestring

industrystring

sizeBandstring

countrystring

websitestring

ownerUserIdstring

statusstring

notesstring

{
  "name": "string",
  "industry": "string",
  "sizeBand": "string",
  "country": "string",
  "website": "string",
  "ownerUserId": "string",
  "status": "new",
  "notes": "string"
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/outbound/accounts/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","industry":"string","sizeBand":"string","country":"string","website":"string","ownerUserId":"string","status":"new","notes":"string"}'

TypeScript

Python

PHP

Ruby

Java