SUBACCOUNTS

Update a subaccount

Changes the details on an existing subaccount

post/subaccount/edit

Request

Base URL
https://api.smtp2go.com/v3
Auth
- API key in header X-Smtp2go-Api-Key
- or HTTP bearer
TypeScript
https://skmtc.dev/smtp2go/apis/smtp2go-api-v3-0-4/docs/subaccount/edit/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

idstring required

The id of an existing subaccount

fullnamestring

If provided, will set to the new full name for the subaccount

limitinteger

If provided, will set to the new limit for the subaccount

dedicated_ipboolean

If provided, will set to the new dedicated IP address for the subaccount (If limit is greater than 100,000)

archivingboolean

Choose whether the subaccount is allowed to enable archiving. You still need to turn on archiving for individual senders within the subaccount.

enforce_2faboolean

Enforce team members of this subaccount to use 2FA.

enable_smsboolean

Enable SMS messaging for the subaccount. Additional charges apply.

sms_limitinteger

Your subaccount will be able to send up to this monthly limit of SMS messages. Their sending will also be limited by the master account's overall monthly limit.

Response

Subaccount updated

request_idstring required

Example response

{
  "request_id": "0ef3f48a-2cfb-11eb-aee9-408d5cce2644",
  "data": {
    "name": "Test Person",
    "id": "NDU5OTgw",
    "plan_size": 10000,
    "plan_remaining": 10000,
    "state": "Active",
    "sms_limit": 1000
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.