{ "opencollection": "1.0.0", "info": { "name": "MX Platform accounts goals API", "version": "20111101" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "goals", "type": "folder" }, "items": [ { "info": { "name": "List goals", "type": "http" }, "http": { "method": "GET", "url": "https://int-api.mx.com/users/:user_guid/goals", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique identifier for a `user`, beginning with the prefix `USR-`." }, { "name": "page", "value": "1", "type": "query", "description": "Results are paginated. Specify current page." }, { "name": "records_per_page", "value": "10", "type": "query", "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead." } ] }, "docs": "List all goals a user can set." }, { "info": { "name": "Create a goal", "type": "http" }, "http": { "method": "POST", "url": "https://int-api.mx.com/users/:user_guid/goals", "params": [ { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique identifier for a `user`, beginning with the prefix `USR-`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a goal. This endpoint accepts the optional `MX-Skip-Webhook` header and `skip_webhook` parameter." }, { "info": { "name": "Read a goal", "type": "http" }, "http": { "method": "GET", "url": "https://int-api.mx.com/users/:user_guid/goals/:goal_guid", "params": [ { "name": "goal_guid", "value": "", "type": "path", "description": "The unique identifier for a goal. Defined by MX." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "docs": "Read a specific goal." }, { "info": { "name": "Update a goal", "type": "http" }, "http": { "method": "PUT", "url": "https://int-api.mx.com/users/:user_guid/goals/:goal_guid", "params": [ { "name": "goal_guid", "value": "", "type": "path", "description": "The unique identifier for a goal. Defined by MX." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique identifier for a `user`, beginning with the prefix `USR-`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates a specific goal." }, { "info": { "name": "Delete a goal", "type": "http" }, "http": { "method": "DELETE", "url": "https://int-api.mx.com/users/:user_guid/goals/:goal_guid", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "goal_guid", "value": "", "type": "path", "description": "The unique identifier for a goal. Defined by MX." }, { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique identifier for a `user`, beginning with the prefix `USR-`." } ] }, "docs": "Delete a goal." }, { "info": { "name": "Reposition goals", "type": "http" }, "http": { "method": "PUT", "url": "https://int-api.mx.com/users/:user_guid/goals/reposition", "params": [ { "name": "user_guid", "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "type": "path", "description": "The unique identifier for a `user`, beginning with the prefix `USR-`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint repositions goal priority levels. If one goal is set to a lower priority, then any other goals need to be adjusted accordingly." } ] } ], "bundled": true }