push_domain
The push_domain method transfers a domain and all its mailboxes and mail to another company. The receiving company must first allow domains to be pushed from this company by adding this company's company id to that company's domain_push_allowed attribute.
Syntax
{
<credentials object>,
"domain" : <domain_name>,
"new_company" : <company_id>,
}Request fields for change_domain_bulletin
The following fields can be used in the change_domain_bulletin method:
Field name | Obligation | Definition/Value |
|---|---|---|
domain | Required | Domain to transfer to the new company |
new_company | Required | company_id of the company that will receive the domain and mailboxes. |
Response fields for change_domain_bulletin
The following fields may be returned in response to the change_domain_bulletin method:
Field name | Field name | Description/Value |
|---|---|---|
error | Returned if success = false | A text string that explains the error. |
error_number | Returned if success = false | A number that represents the error. |
success | Always returned | Indicates whether the request was successful or not. Allowed values are true and false. |
Examples for change_domain_bulletin
Example 1
Push a domain example.com to company with company_id 12345
Request
{
"credentials": {
"user": "[email protected]",
"password": "sw0rdfish"
},
"domain": "example.com",
"new_company":"12345"
}Response
{
"success": true
}Updated 1 day ago