HisendHISEND Docs

Edit projects

PATCH
/admin/projects/{id}

Requires a user JWT with the admin role.

Authorization

AdminJWT
AuthorizationBearer <token>

User JWT; backend checks the admin role. Project API keys cannot access admin endpoints.

In: header

Path Parameters

id*integer
Range0 <= value

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://api.hisend.app/v1/admin/projects/0" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": 0,
  "user_id": 0,
  "reputation_score": 0,
  "bounced": 0,
  "failed": 0,
  "complained": 0,
  "name": "string",
  "created_at": "string",
  "updated_at": "string",
  "is_locked": true,
  "allow_hisend_mta": true,
  "plan_id": 1,
  "admin_plan_id": 1,
  "polar_subscription_id": "string",
  "polar_subscription_status": "string",
  "polar_product_id": "string",
  "admin_subscription_status": "string",
  "plan": {
    "id": 0,
    "max_domains": 0,
    "max_users": 0,
    "max_mails_per_day": 0,
    "max_mails_per_month": 0,
    "name": "string",
    "description": "string",
    "support_level": "string",
    "polar_product_id": "string",
    "created_at": "string",
    "updated_at": "string",
    "price": 0,
    "is_active": true
  }
}
{
  "error": "string",
  "message": "string"
}
{
  "error": "string",
  "message": "string"
}
{
  "error": "string",
  "message": "string"
}
{
  "error": "string",
  "message": "string"
}
{
  "error": "string",
  "message": "string"
}
{
  "error": "string",
  "message": "string"
}
{
  "error": "string",
  "message": "string"
}
{
  "error": "string",
  "message": "string"
}

Edit plan PATCH

Requires a user JWT with the admin role.

Edit api-keys PATCH

Requires a user JWT with the admin role. Domain edits register replacement identities and reset verification. Address routes require explicit replacements or explicit preservation of local parts. Endpoint and routing edits submit the complete editable configuration.