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/inbox-views

Request body

application/json

namestringrequired

filtersobjectrequired

Show child parameters

categorystring

connectionIdstring

assigneeUserIdstring

sequenceIdstring

unreadboolean

labelstring

leadStatusstring

sharedboolean

= false

{
  "name": "string",
  "filters": {
    "category": "positive",
    "connectionId": "string",
    "assigneeUserId": "string",
    "sequenceId": "string",
    "unread": true,
    "label": "string",
    "leadStatus": "new"
  },
  "shared": false
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/inbox-views" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","filters":{"category":"positive","connectionId":"string","assigneeUserId":"string","sequenceId":"string","unread":true,"label":"string","leadStatus":"new"},"shared":false}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "name": "string",
  "filters": {
    "category": "positive",
    "connectionId": "string",
    "assigneeUserId": "string",
    "sequenceId": "string",
    "unread": true,
    "label": "string",
    "leadStatus": "new"
  },
  "ownerUserId": "string",
  "shared": true,
  "position": 0
}

Schema

idstringrequired

namestringrequired

filtersobjectrequired

Show child parameters

categorystring

connectionIdstring

assigneeUserIdstring

sequenceIdstring

unreadboolean

labelstring

leadStatusstring

ownerUserIdstringrequired

sharedbooleanrequired

positionintegerrequired

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/inbox-views

DELETEhttps://hermeticor.com/v1/outbound/inbox-views/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · POST /v1/outbound/inbox-views

5XX Default Response

Same as 4XX · POST /v1/outbound/inbox-views

POSThttps://hermeticor.com/v1/outbound/inbox/bulk

Request body

application/json

idsstring[]required

actionobjectrequired

{
  "ids": [
    "string"
  ],
  "action": {
    "type": "read"
  }
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/inbox/bulk" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["string"],"action":{"type":"read"}}'

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 · POST /v1/outbound/inbox-views

5XX Default Response

Same as 4XX · POST /v1/outbound/inbox-views

GEThttps://hermeticor.com/v1/outbound/reply-snippets

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/reply-snippets" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "body": "string",
      "ownerUserId": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem126[]required

Show child parameters

idstringrequired

namestringrequired

bodystringrequired

ownerUserIdstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/outbound/inbox-views

5XX Default Response

Same as 4XX · POST /v1/outbound/inbox-views

POSThttps://hermeticor.com/v1/outbound/reply-snippets

Request body

application/json

namestringrequired

bodystringrequired

{
  "name": "string",
  "body": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/reply-snippets" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","body":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "name": "string",
  "body": "string",
  "ownerUserId": "string"
}

Schema

idstringrequired

namestringrequired

bodystringrequired

ownerUserIdstringrequired

4XX Default Response

Same as 4XX · POST /v1/outbound/inbox-views

5XX Default Response

Same as 4XX · POST /v1/outbound/inbox-views

PUThttps://hermeticor.com/v1/outbound/reply-snippets/{id}

Parameters

idstringpathrequired

Request body

application/json

namestringrequired

bodystringrequired

{
  "name": "string",
  "body": "string"
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/outbound/reply-snippets/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","body":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/outbound/reply-snippets

4XX Default Response

Same as 4XX · POST /v1/outbound/inbox-views

5XX Default Response

Same as 4XX · POST /v1/outbound/inbox-views

DELETEhttps://hermeticor.com/v1/outbound/reply-snippets/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/outbound/inbox-views/{id}

4XX Default Response

Same as 4XX · POST /v1/outbound/inbox-views

5XX Default Response

Same as 4XX · POST /v1/outbound/inbox-views

POSThttps://hermeticor.com/v1/outbound/inbox/{id}/presence

Parameters

idstringpathrequired

Request body

application/json

composingboolean

= false

{
  "composing": false
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/inbox/{id}/presence" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"composing":false}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "userId": "string",
      "composing": true,
      "seenAt": "2024-01-01T00:00:00Z"
    }
  ]
}

Schema

itemsobject[]required

Show child parameters

userIdstringrequired

composingbooleanrequired

seenAtstringrequired

4XX Default Response

Same as 4XX · POST /v1/outbound/inbox-views

5XX Default Response

Same as 4XX · POST /v1/outbound/inbox-views

POSThttps://hermeticor.com/v1/outbound/mailboxes/bulk-update

Request body

application/json

connectionIdsstring[]required

settingsobject

Show child parameters

dailyCapinteger

hourlyCapinteger

rampobject

Show child parameters

startDailyintegerrequired

targetDailyintegerrequired

incrementPerDayintegerrequired

startedOnstringrequired

timezonestring

sendingWindowobject

Show child parameters

startMinintegerrequired

endMinintegerrequired

weekdaysinteger[]

pacingobject

Show child parameters

minGapSecintegerrequired

jitterSecintegerrequired

metaobject

Show child parameters

displayNamestring

tagsstring[]

groupNamestring

capJitterPctinteger

signaturestring

bccstring

trackingDomainstring

{
  "connectionIds": [
    "string"
  ],
  "settings": {
    "dailyCap": 0,
    "hourlyCap": 0,
    "ramp": {
      "startDaily": 0,
      "targetDaily": 0,
      "incrementPerDay": 0,
      "startedOn": "string"
    },
    "timezone": "string",
    "sendingWindow": {
      "startMin": 0,
      "endMin": 0,
      "weekdays": [
        0
      ]
    },
    "pacing": {
      "minGapSec": 0,
      "jitterSec": 0
    }
  },
  "meta": {
    "displayName": "string",
    "tags": [
      "string"
    ],
    "groupName": "string",
    "capJitterPct": 0,
    "signature": "string",
    "bcc": "string",
    "trackingDomain": "string"
  }
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/mailboxes/bulk-update" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"connectionIds":["string"],"settings":{"dailyCap":0,"hourlyCap":0,"ramp":{"startDaily":0,"targetDaily":0,"incrementPerDay":0,"startedOn":"string"},"timezone":"string","sendingWindow":{"startMin":0,"endMin":0,"weekdays":[0]},"pacing":{"minGapSec":0,"jitterSec":0}},"meta":{"displayName":"string","tags":["string"],"groupName":"string","capJitterPct":0,"signature":"string","bcc":"string","trackingDomain":"string"}}'

TypeScript

Python

PHP

Ruby

Java