Account Config
| API version | 3.1 |
|---|---|
| Last Update | 10/22/2019 |
| Authentication | YES |
| Response Format | JSON |
| HTTP Method | POST |
| Rate limited | YES |
| Requests per rate limit | 10/min |
| Change History | 10/22/2019: add new regcode section |
Use this API to retrieve account settings.
API URL
Request Parameters
| Key | Datatype | Parameter Type | Required | Description | Default |
|---|---|---|---|---|---|
| access_token | string | URL | Yes | access token which archived from OAuth authentication step | |
| sections | Array of strings | Body | Yes | Specify which settings to fetch information. Available options:
|
Response HTTP Code
See details in the Response HTTP Code section in this page
Response Parameters
| Key | Datatype | Description |
|---|---|---|
| <setting_name> | object | a setting name in the request. Depend on settings, object will have different keys in response |
| cross-domain-api | object | Cross-domain API setting |
| cross-domain-api.enabled | number | Values:
|
| cross-domain-api.port | number | port number which the cross-domain API is listening on endpoints |
| regcode | string | Account specific registration Shortcode |
Example
Request Example
Response Example
History
| Action | Version | URL |
|---|---|---|
| Account Config | 3.0 | auto$ |
Was this page helpful?
