agency

Embed

<a href="https://hermeticor.com/docs/ref-agency"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/d6096380-dd79-4ee6-8cf7-ad5c6d7beaf6/social-card.svg?v=3e7ae33eec8b" alt="agency" width="600" height="315"></a>

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

Last 30 days of outbound results per client workspace of your agency (null when you are not in an agency). Each client is read in its own tenant after a membership check

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/agency/outbound"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "days": 0,
  "clients": [
    {
      "id": "string",
      "name": "string",
      "readable": true,
      "sent": 0,
      "bounced": 0,
      "replied": 0,
      "positive": 0,
      "meetings": 0,
      "replyRate": 0,
      "interestedRate": 0,
      "bounceRate": 0,
      "openPipelineCents": 0,
      "wonCents": 0,
      "liveSequences": 0,
      "mailboxes": 0,
      "pausedMailboxes": 0
    }
  ]
}

Schema

daysintegerrequired

clientsobject[]required

Show child parameters

idstringrequired

namestringrequired

readablebooleanrequired

sentintegerrequired

bouncedintegerrequired

repliedintegerrequired

positiveintegerrequired

meetingsintegerrequired

replyRatenumberrequired

interestedRatenumberrequired

bounceRatenumberrequired

openPipelineCentsintegerrequired

wonCentsintegerrequired

liveSequencesintegerrequired

mailboxesintegerrequired

pausedMailboxesintegerrequired

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/agency/outbound

GEThttps://hermeticor.com/v1/agency

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/agency"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "organizationId": "string",
  "name": "string",
  "role": "string",
  "clients": [
    {
      "id": "string",
      "name": "string",
      "timezone": "string",
      "metrics": {
        "sent30d": 0,
        "clicked30d": 0,
        "activeFlows": 0,
        "activeCampaigns": 0
      },
      "status": "active",
      "deleteAfter": null,
      "quota": null,
      "usage": null,
      "reputation": null
    }
  ]
}

Schema

organizationIdstringrequired

namestringrequired

rolestringrequired

clientsobject[]required

Show child parameters

idstringrequired

namestringrequired

timezonestringrequired

metricsobjectrequired

Show child parameters

sent30dintegerrequired

clicked30dintegerrequired

activeFlowsintegerrequired

activeCampaignsintegerrequired

statusstringrequired

active | paused | pending_deletion = active

deleteAfterstringrequired

= null

quotaobjectrequired

= null

Show child parameters

sendsEmailintegerrequired

sendsSmsintegerrequired

usageobjectrequired

= null

Show child parameters

periodstringrequired

sends_emailintegerrequired

sends_smsintegerrequired

sends_whatsappintegerrequired

sends_pushintegerrequired

sends_postcardintegerrequired

ai_tokensintegerrequired

reputationobjectrequired

= null

Show child parameters

sent30dintegerrequired

bounceRatenumberrequired

complaintRatenumberrequired

ratingstringrequired

good | watch | poor | unknown

4XX Default Response

Same as 4XX · GET /v1/agency/outbound

5XX Default Response

Same as 4XX · GET /v1/agency/outbound

POSThttps://hermeticor.com/v1/agency/enable

Turn the current workspace's organization into an agency; the caller becomes its owner

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/agency/enable"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · GET /v1/agency/outbound

5XX Default Response

Same as 4XX · GET /v1/agency/outbound

POSThttps://hermeticor.com/v1/agency/clients

Request body

application/json

namestringrequired

timezonestring

{
  "name": "string",
  "timezone": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/agency/clients" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","timezone":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

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

Schema

idstringrequired

namestringrequired

4XX Default Response

Same as 4XX · GET /v1/agency/outbound

5XX Default Response

Same as 4XX · GET /v1/agency/outbound

GEThttps://hermeticor.com/v1/agency/clients/{workspaceId}

One client: lifecycle state, send quota, this month's usage and 30-day reputation

Parameters

workspaceIdstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/agency/clients/{workspaceId}"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "name": "string",
  "status": "active",
  "pausedAt": "2024-01-01T00:00:00Z",
  "pausedReason": "string",
  "deleteAfter": "2024-01-01T00:00:00Z",
  "quota": {
    "sendsEmail": 0,
    "sendsSms": 0
  },
  "usage": {
    "period": "string",
    "sends_email": 0,
    "sends_sms": 0,
    "sends_whatsapp": 0,
    "sends_push": 0,
    "sends_postcard": 0,
    "ai_tokens": 0
  },
  "reputation": {
    "sent30d": 0,
    "bounceRate": 0,
    "complaintRate": 0,
    "rating": "good"
  }
}

Schema

idstringrequired

namestringrequired

statusstringrequired

active | paused | pending_deletion

pausedAtstringrequired

pausedReasonstringrequired

deleteAfterstringrequired

quotaobjectrequired

Show child parameters

sendsEmailintegerrequired

sendsSmsintegerrequired

usageobjectrequired

Show child parameters

periodstringrequired

sends_emailintegerrequired

sends_smsintegerrequired

sends_whatsappintegerrequired

sends_pushintegerrequired

sends_postcardintegerrequired

ai_tokensintegerrequired

reputationobjectrequired

Show child parameters

sent30dintegerrequired

bounceRatenumberrequired

complaintRatenumberrequired

ratingstringrequired

good | watch | poor | unknown

4XX Default Response

Same as 4XX · GET /v1/agency/outbound

5XX Default Response

Same as 4XX · GET /v1/agency/outbound

PATCHhttps://hermeticor.com/v1/agency/clients/{workspaceId}

Rename a client workspace from the agency

Parameters

workspaceIdstringpathrequired

Request body

application/json

namestringrequired

{
  "name": "string"
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/agency/clients/{workspaceId}" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/agency/clients

4XX Default Response

Same as 4XX · GET /v1/agency/outbound

5XX Default Response

Same as 4XX · GET /v1/agency/outbound

POSThttps://hermeticor.com/v1/agency/clients/{workspaceId}/pause

Pause a client workspace: every send request is refused until it is resumed

Parameters

workspaceIdstringpathrequired

Request body

application/json

reasonstring

{
  "reason": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/agency/clients/{workspaceId}/pause" \
  -H "Content-Type: application/json" \
  -d '{"reason":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/agency/enable

4XX Default Response

Same as 4XX · GET /v1/agency/outbound

5XX Default Response

Same as 4XX · GET /v1/agency/outbound

POSThttps://hermeticor.com/v1/agency/clients/{workspaceId}/resume

Resume a paused client (also cancels a pending deletion)

Parameters

workspaceIdstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/agency/clients/{workspaceId}/resume"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/agency/enable

4XX Default Response

Same as 4XX · GET /v1/agency/outbound

5XX Default Response

Same as 4XX · GET /v1/agency/outbound

POSThttps://hermeticor.com/v1/agency/clients/{workspaceId}/delete

Schedule deletion after a grace period; the client is paused immediately and resume cancels it

Parameters

workspaceIdstringpathrequired

Request body

application/json

graceDaysinteger

= 30

{
  "graceDays": 30
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/agency/clients/{workspaceId}/delete" \
  -H "Content-Type: application/json" \
  -d '{"graceDays":30}'

TypeScript

Python

PHP

Ruby

Java

Responses

202 Default Response

Example

{
  "deleteAfter": "string"
}

Schema

deleteAfterstringrequired

4XX Default Response

Same as 4XX · GET /v1/agency/outbound

5XX Default Response

Same as 4XX · GET /v1/agency/outbound

Next part

Updated Nov 8, 2026

Was this page helpful?