connections

Embed

<a href="https://hermeticor.com/docs/ref-connections"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/f97af7f7-078d-4412-8c6a-b40f548f2c71/social-card.svg?v=3e7ae33eec8b" alt="connections" width="600" height="315"></a>

POSThttps://hermeticor.com/v1/sender-pools

Request body

application/json

namestringrequired

channelstringrequired

email | sms | whatsapp | push | postcard

strategystring

round_robin | weighted | least_used | sticky_per_recipient = round_robin

membersMembersItem2[]

= []

Show child parameters

connectionIdstringrequired

senderIdentityIdstring

= null

weightinteger

= 1

matchProviderboolean

{
  "name": "string",
  "channel": "email",
  "strategy": "round_robin",
  "members": [],
  "matchProvider": true
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/sender-pools" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","channel":"email","strategy":"round_robin","members":[],"matchProvider":true}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 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

Example

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

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · POST /v1/sender-pools

GEThttps://hermeticor.com/v1/sender-pools/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/sender-pools

4XX Default Response

Same as 4XX · POST /v1/sender-pools

5XX Default Response

Same as 4XX · POST /v1/sender-pools

DELETEhttps://hermeticor.com/v1/sender-pools/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/sender-pools/{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/sender-pools

5XX Default Response

Same as 4XX · POST /v1/sender-pools

PATCHhttps://hermeticor.com/v1/sender-pools/{id}

Parameters

idstringpathrequired

Request body

application/json

namestring

strategystring

round_robin | weighted | least_used | sticky_per_recipient

membersMembersItem2[]

Show child parameters

connectionIdstringrequired

senderIdentityIdstring

= null

weightinteger

= 1

matchProviderboolean

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

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/sender-pools/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","strategy":"round_robin","members":[{"connectionId":"string","senderIdentityId":null,"weight":1}],"matchProvider":true}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/sender-pools

4XX Default Response

Same as 4XX · POST /v1/sender-pools

5XX Default Response

Same as 4XX · POST /v1/sender-pools

GEThttps://hermeticor.com/v1/route-policies

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "name": "string",
      "purpose": "marketing",
      "rules": {
        "rules": [],
        "fallback": []
      },
      "id": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem23[]required

Show child parameters

namestringrequired

purposestringrequired

marketing | prospecting | transactional | operational

rulesobjectrequired

Show child parameters

rulesRulesItem[]required

= []

fallbackTarget[]required

= []

idstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/sender-pools

5XX Default Response

Same as 4XX · POST /v1/sender-pools

POSThttps://hermeticor.com/v1/route-policies

Request body

application/json

namestringrequired

purposestringrequired

marketing | prospecting | transactional | operational

rulesobjectrequired

Show child parameters

rulesRulesItem2[]

= []

Show child parameters

matchobjectrequired

targetobjectrequired

fallbackTarget2[]

= []

Show child parameters

poolIdstring

connectionIdstring

{
  "name": "string",
  "purpose": "marketing",
  "rules": {
    "rules": [],
    "fallback": []
  }
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/route-policies" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","purpose":"marketing","rules":{"rules":[],"fallback":[]}}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "name": "string",
  "purpose": "marketing",
  "rules": {
    "rules": [],
    "fallback": []
  },
  "id": "string"
}

Schema

namestringrequired

purposestringrequired

marketing | prospecting | transactional | operational

rulesobjectrequired

Show child parameters

rulesRulesItem[]required

= []

Show child parameters

matchobjectrequired

targetobjectrequired

fallbackTarget[]required

= []

Show child parameters

poolIdstring

connectionIdstring

idstringrequired

4XX Default Response

Same as 4XX · POST /v1/sender-pools

5XX Default Response

Same as 4XX · POST /v1/sender-pools

GEThttps://hermeticor.com/v1/route-policies/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/route-policies

4XX Default Response

Same as 4XX · POST /v1/sender-pools

5XX Default Response

Same as 4XX · POST /v1/sender-pools

DELETEhttps://hermeticor.com/v1/route-policies/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/sender-pools/{id}

4XX Default Response

Same as 4XX · POST /v1/sender-pools

5XX Default Response

Same as 4XX · POST /v1/sender-pools

PATCHhttps://hermeticor.com/v1/route-policies/{id}

Parameters

idstringpathrequired

Request body

application/json

namestring

purposestring

marketing | prospecting | transactional | operational

rulesobject

Show child parameters

rulesRulesItem2[]

= []

Show child parameters

matchobjectrequired

targetobjectrequired

fallbackTarget2[]

= []

Show child parameters

poolIdstring

connectionIdstring

{
  "name": "string",
  "purpose": "marketing",
  "rules": {
    "rules": [],
    "fallback": []
  }
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/route-policies/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","purpose":"marketing","rules":{"rules":[],"fallback":[]}}'

TypeScript

Python

PHP

Ruby

Java