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/inbox/{id}/drafts

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "inboundId": "string",
      "profileId": "string",
      "authorUserId": "string",
      "subject": "string",
      "body": "string",
      "connectionId": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem131[]required

Show child parameters

idstringrequired

inboundIdstringrequired

profileIdstringrequired

authorUserIdstringrequired

subjectstringrequired

bodystringrequired

connectionIdstringrequired

createdAtstringrequired

updatedAtstringrequired

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/inbox/{id}/drafts

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

Parameters

idstringpathrequired

Request body

application/json

bodystringrequired

subjectstring

connectionIdstring

{
  "body": "string",
  "subject": "string",
  "connectionId": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/inbox/{id}/drafts" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"body":"string","subject":"string","connectionId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "inboundId": "string",
  "profileId": "string",
  "authorUserId": "string",
  "subject": "string",
  "body": "string",
  "connectionId": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

inboundIdstringrequired

profileIdstringrequired

authorUserIdstringrequired

subjectstringrequired

bodystringrequired

connectionIdstringrequired

createdAtstringrequired

updatedAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/outbound/inbox/{id}/drafts

5XX Default Response

Same as 4XX · GET /v1/outbound/inbox/{id}/drafts

GEThttps://hermeticor.com/v1/outbound/inbox/{id}/drafts/{draftId}

Parameters

idstringpathrequired

draftIdstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/outbound/inbox/{id}/drafts

4XX Default Response

Same as 4XX · GET /v1/outbound/inbox/{id}/drafts

5XX Default Response

Same as 4XX · GET /v1/outbound/inbox/{id}/drafts

PUThttps://hermeticor.com/v1/outbound/inbox/{id}/drafts/{draftId}

Parameters

idstringpathrequired

draftIdstringpathrequired

Request body

application/json

bodystringrequired

subjectstring

connectionIdstring

{
  "body": "string",
  "subject": "string",
  "connectionId": "string"
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/outbound/inbox/{id}/drafts/{draftId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"body":"string","subject":"string","connectionId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/outbound/inbox/{id}/drafts

4XX Default Response

Same as 4XX · GET /v1/outbound/inbox/{id}/drafts

5XX Default Response

Same as 4XX · GET /v1/outbound/inbox/{id}/drafts

DELETEhttps://hermeticor.com/v1/outbound/inbox/{id}/drafts/{draftId}

Parameters

idstringpathrequired

draftIdstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/outbound/inbox/{id}/drafts/{draftId}" \
  -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 · GET /v1/outbound/inbox/{id}/drafts

5XX Default Response

Same as 4XX · GET /v1/outbound/inbox/{id}/drafts

POSThttps://hermeticor.com/v1/outbound/inbox/{id}/drafts/{draftId}/send

Send the draft as a reply (consent and suppression still apply) and delete it

Parameters

idstringpathrequired

draftIdstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/inbox/{id}/drafts/{draftId}/send" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

202 Default Response

Example

{
  "jobId": "string",
  "status": "queued",
  "reason": "string"
}

Schema

jobIdstringrequired

statusstringrequired

queued | blocked | deferred | duplicate

reasonstring

4XX Default Response

Same as 4XX · GET /v1/outbound/inbox/{id}/drafts

5XX Default Response

Same as 4XX · GET /v1/outbound/inbox/{id}/drafts

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

Parameters

idstringpathrequired

Request body

application/json

valuebooleanrequired

{
  "value": true
}

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/outbound/inbox/{id}/drafts/{draftId}

4XX Default Response

Same as 4XX · GET /v1/outbound/inbox/{id}/drafts

5XX Default Response

Same as 4XX · GET /v1/outbound/inbox/{id}/drafts

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

Parameters

idstringpathrequired

Request body

application/json

atstringrequired

{
  "at": "2024-01-01T00:00:00Z"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/outbound/inbox/{id}/remind" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"at":"2024-01-01T00:00:00Z"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/outbound/inbox/{id}/drafts/{draftId}

4XX Default Response

Same as 4XX · GET /v1/outbound/inbox/{id}/drafts

5XX Default Response

Same as 4XX · GET /v1/outbound/inbox/{id}/drafts

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

Ignore a reply: hide it and take it out of the reply counters

Parameters

idstringpathrequired

Request body

application/json

valuebooleanrequired

{
  "value": true
}

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/outbound/inbox/{id}/drafts/{draftId}

4XX Default Response

Same as 4XX · GET /v1/outbound/inbox/{id}/drafts

5XX Default Response

Same as 4XX · GET /v1/outbound/inbox/{id}/drafts

Next part

Updated Nov 8, 2026

Was this page helpful?