Account Management

Perform account-level CRUD operations.

Update variable account settings

put/v5/accounts

Update variable account settings

SecuritybasicAuth

Request

query Parameters

name	string The new account organization name
inactive_session_timeout	integer The login session timeout period for inactivity
absolute_session_timeout	integer The login session timeout period limit
logout_redirect_url	string The url to redirect to upon logout

Responses

200

Successfully updated the account setting(s)

Response Schema: application/json

message

string

Response message

400

Error response

Request samples

Response samples

200
400

application/json

{"message": "Account info has been updated"
}

Get webhook signing key saved on the account

get/v5/accounts/http_signing_key

Get webhook signing key saved on the account

SecuritybasicAuth

Responses

200

A 200 response

Response Schema: application/json

message	string Success message
http_signing_key	string Decoded webhook signing key

400

Error response

Request samples

Response samples

200
400

application/json

{"http_signing_key": "key-55c5c5c5c55f55ca5cd5f55d5c555c55"
}

Create or regenerate webhook signing key on an account

post/v5/accounts/http_signing_key

Create or regenerate webhook signing key on an account

SecuritybasicAuth

Responses

200

A 200 response

Response Schema: application/json

message	string Success message
http_signing_key	string Decoded webhook signing key

Request samples

Response samples

200

application/json

{"message": "regenerated HTTP signing key for account",
"http_signing_key": "key-55c5c5c5c55f55ca5cd5f55d5c555c55"
}

Get authorized email recipients for a sandbox domain

get/v5/sandbox/auth_recipients

Get webhook signing key saved on the account

SecuritybasicAuth

Responses

200

A 200 response

Response Schema: application/json

Array of objects

Array

email	string Email address of sandbox domain recipient
activated	boolean Activated/verified status of the recipient

Request samples

Response samples

200

application/json

{"recipients": [{"email": "[email protected]",
"activated": true
}
]
}

Add authorized email recipient for a sandbox domain

post/v5/sandbox/auth_recipients

Add authorized email recipient for a sandbox domain

SecuritybasicAuth

Request

query Parameters

email

required

string

The email address of the new recipient

Responses

200

A 200 response

Response Schema: application/json

object

email	string Email address of sandbox domain recipient
activated	boolean Activated/verified status of the recipient

400

Error response

Request samples

Response samples

200
400

application/json

{"recipient": {"email": "[email protected]",
"activated": false
}
}

Remove an authorized sandbox domain email recipient

delete/v5/sandbox/auth_recipients/{email}

Remove an authorized sandbox domain email recipient

SecuritybasicAuth

Request

path Parameters

email

required

string

The email address of the authorized recipient to be removed

Responses

200

A 200 response

Response Schema: application/json

message

string

Response message

400

Error response

Request samples

Response samples

200
400

application/json

{"message": "Sandbox recipient deleted."
}

Resend account activation email to the account owner

post/v5/accounts/resend_activation_email

Resend account activation email to the account owner

SecuritybasicAuth

Responses

200

A 200 response

Response Schema: application/json

success

boolean

Indicates success of request

Request samples

Response samples

200

application/json

{"success": true
}