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>

PUThttps://hermeticor.com/v1/outbound/task-types/{id}

Parameters

idstringpathrequired

Request body

application/json

keystringrequired

labelstringrequired

colorstring

= #6b7280

outcomesstring[]

= []

positioninteger

= 0

{
  "key": "string",
  "label": "string",
  "color": "#6b7280",
  "outcomes": [],
  "position": 0
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/outbound/task-types/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"key":"string","label":"string","color":"#6b7280","outcomes":[],"position":0}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "key": "string",
  "label": "string",
  "color": "#6b7280",
  "outcomes": [],
  "position": 0,
  "id": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}

Schema

keystringrequired

labelstringrequired

colorstringrequired

= #6b7280

outcomesstring[]required

= []

positionintegerrequired

= 0

idstringrequired

createdAtstringrequired

updatedAtstringrequired

4XX Default Response

Example

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

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · PUT /v1/outbound/task-types/{id}

DELETEhttps://hermeticor.com/v1/outbound/task-types/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/outbound/task-types/{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 · PUT /v1/outbound/task-types/{id}

5XX Default Response

Same as 4XX · PUT /v1/outbound/task-types/{id}

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

Assign, snooze, complete or skip many tasks at once

Request body

application/json

idsstring[]required

actionobjectrequired

{
  "ids": [
    "string"
  ],
  "action": {
    "op": "assign",
    "assigneeUserId": "string"
  }
}

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

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

Schema

updatedintegerrequired

failedFailedItem2[]required

Show child parameters

idstringrequired

errorstringrequired

4XX Default Response

Same as 4XX · PUT /v1/outbound/task-types/{id}

5XX Default Response

Same as 4XX · PUT /v1/outbound/task-types/{id}

GEThttps://hermeticor.com/v1/outbound/voice-clips

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "contentType": "string",
      "bytes": 0,
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem217[]required

Show child parameters

idstringrequired

namestringrequired

contentTypestringrequired

bytesintegerrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · PUT /v1/outbound/task-types/{id}

5XX Default Response

Same as 4XX · PUT /v1/outbound/task-types/{id}

POSThttps://hermeticor.com/v1/outbound/voice-clips

Upload an audio clip (multipart field "file"): MP3, M4A, OGG, WAV or WebM up to 5 MB

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "name": "string",
  "contentType": "string",
  "bytes": 0,
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

namestringrequired

contentTypestringrequired

bytesintegerrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · PUT /v1/outbound/task-types/{id}

5XX Default Response

Same as 4XX · PUT /v1/outbound/task-types/{id}

DELETEhttps://hermeticor.com/v1/outbound/voice-clips/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/outbound/task-types/{id}

4XX Default Response

Same as 4XX · PUT /v1/outbound/task-types/{id}

5XX Default Response

Same as 4XX · PUT /v1/outbound/task-types/{id}

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

The connected Twilio Voice account (the auth token is never returned)

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "provider": "string",
  "accountSid": "string",
  "fromNumber": "string",
  "last4": "string"
}

Schema

providerstringrequired

accountSidstringrequired

fromNumberstringrequired

last4stringrequired

4XX Default Response

Same as 4XX · PUT /v1/outbound/task-types/{id}

5XX Default Response

Same as 4XX · PUT /v1/outbound/task-types/{id}

PUThttps://hermeticor.com/v1/outbound/telephony

Request body

application/json

accountSidstringrequired

authTokenstringrequired

fromNumberstringrequired

{
  "accountSid": "string",
  "authToken": "string",
  "fromNumber": "string"
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/outbound/telephony" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"accountSid":"string","authToken":"string","fromNumber":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/outbound/telephony

4XX Default Response

Same as 4XX · PUT /v1/outbound/task-types/{id}

5XX Default Response

Same as 4XX · PUT /v1/outbound/task-types/{id}

DELETEhttps://hermeticor.com/v1/outbound/telephony

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/outbound/task-types/{id}

4XX Default Response

Same as 4XX · PUT /v1/outbound/task-types/{id}

5XX Default Response

Same as 4XX · PUT /v1/outbound/task-types/{id}

GEThttps://hermeticor.com/v1/outbound/telephony/my-phone

Your own phone for click-to-call (Twilio rings it first)

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "phone": "string"
}

Schema

phonestringrequired

4XX Default Response

Same as 4XX · PUT /v1/outbound/task-types/{id}

5XX Default Response

Same as 4XX · PUT /v1/outbound/task-types/{id}

PUThttps://hermeticor.com/v1/outbound/telephony/my-phone

Request body

application/json

phonestringrequired

{
  "phone": "string"
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/outbound/telephony/my-phone" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"phone":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/outbound/telephony/my-phone

4XX Default Response

Same as 4XX · PUT /v1/outbound/task-types/{id}

5XX Default Response

Same as 4XX · PUT /v1/outbound/task-types/{id}

Next part

Updated Nov 8, 2026

Was this page helpful?