GetMX-API
  1. Group Pay
GetMX-API
  • Domain
    • Get Domains
      POST
    • Add Domain
      POST
    • Delete Domain
      POST
    • Get Domain Detail
      POST
    • Bind Domain to Group-Pay
      POST
    • Unbind Domain from Group-Pay
      POST
    • Update Domain
      POST
  • Group Pay
    • Get Group-Pays
      POST
    • Add Group-Pay
      POST
    • Update Group-Pay
      POST
  • Email
    • Get Emails
      POST
    • Add Email
      POST
    • Delete Email
      POST
    • Update Email
      POST
    • Clean up Email
      POST
  • Message
    • Get Messages
      POST
    • Get Message Detail
      POST
    • Delete Message
      POST
    • Flagged Message
      POST
    • Seen Message
      POST
    • Answered Message
      POST
    • Get Folders
      POST
    • Move Message Folder
      POST
  • Alias
    • Get Aliases
      POST
    • Add Alias
      POST
    • Delete Alias
      POST
    • Update Alias
      POST
  • Message Notice
    • Get Message Notices
    • Add Message Notice
    • Delete Message Notice
    • Check Message Notice
    • Update Message Notice
  • SMTP Rule
    • Get Smtp Rules
    • Add Smtp Rule
    • Update Smtp Rule
    • Delete Smtp Rule
  • Scale
    • Query Remaining Space
    • Server Cleanup
  1. Group Pay

Update Group-Pay

POST
/v1/group-pay/update
At least one parameter to be modified must be provided; do not include parameters that do not require changes in the request.

Request

Body Params multipart/form-data
token
string 
required
Token generated by the management backend
Example:
{{token}}
group_pay_id
string 
required
Group pay ID (group_pay_id can be obtained from the GetMX backend or through the /v1/group-pay/list endpoint, with the 'id' field corresponding to 'group_pay_id').
Example:
12345678
mark
string 
required
Mark
Example:
mark

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://domain-open-api.getmx.com/v1/group-pay/update' \
--form 'token="token"' \
--form 'group_pay_id="12345678"' \
--form 'mark="mark"'

Responses

🟢200成功
application/json
Body
code
integer 
required
msg
string 
required
data
null 
required
Example
{
  "code": 0,
  "msg": "string",
  "data": null
}
Modified at 2024-12-03 00:48:04
Previous
Add Group-Pay
Next
Get Emails
Built with