{ "opencollection": "1.0.0", "info": { "name": "Bud API Services: Documentation Aggregation Buckets Manage Customers API", "version": "2.10.10" }, "items": [ { "info": { "name": "Manage Customers", "type": "folder" }, "items": [ { "info": { "name": "Retrieve Customers V3", "type": "http" }, "http": { "method": "GET", "url": "https://api-sandbox.thisisbud.com/platform/v3/customers", "headers": [ { "name": "X-Client-Id", "value": "8711bbef-b357-4c2d-97ca-0d9df4206e9a" } ], "params": [ { "name": "date_from", "value": "2022-05-28T00:00:00Z", "type": "query", "description": "Date (RFC3339) to filter customers created on or after which. To maintain backwards compatibility, dates in the format (YYYY-MM-DD) can also be used and will be assumed to be UTC.\n" }, { "name": "date_to", "value": "2022-05-29T00:00:00Z", "type": "query", "description": "Date (RFC3339) to filter customers created on or before which. To maintain backwards compatibility, dates in the format (YYYY-MM-DD) can also be used and will be assumed to be UTC. Uses the current date by default.\n" }, { "name": "page_size", "value": "", "type": "query", "description": "The number of results to return per page. Defaults to 200." }, { "name": "page_token", "value": "", "type": "query", "description": "The token required to fetch a specific page of results. Provided by the next_page_token field in the previous request.\n" }, { "name": "idempotent_identifier", "value": "", "type": "query", "description": "Filter by the internal client identifier provided in the `client_metadata` object when creating the customer in __Create Customer V3__. Only one customer will be returned if one is found with the given identifier.\n" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This endpoint is used to list customers associated with the current project.\n\nCustomers are listed ordered by their ID. Deleted customers will not be included in the list.\n\nThe list of customers can be filtered by creation date with the `date_from` and `date_to` query parameters, which expect dates in the RFC3339 format.\n\nIf more results pages are available, the response metadata object will contain a `next_page_token` field which can be used to fetch the next page of results. The token should " }, { "info": { "name": "Create Customer V3", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.thisisbud.com/platform/v3/customers", "headers": [ { "name": "X-Client-Id", "value": "8711bbef-b357-4c2d-97ca-0d9df4206e9a" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This endpoint is used to create a new Customer in order for them to consume the Bud services.\n\nWhen we refer to a Customer, we're talking about the end-user of yours and Bud's technology. Customer entities in Bud have unique identifiers and this is used to store the customer data on the Bud platform.\n\nFor more information on how to manage your Bud Customers, please, refer to the following [guide](https://docs.thisisbud.com/docs/setup-customers)\n\n> 📘 Note:\n>\n> By specifying a `client_metadata.id" }, { "info": { "name": "Create Customers V3 (Batch)", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.thisisbud.com/platform/v3/customers/batch", "headers": [ { "name": "X-Client-Id", "value": "8711bbef-b357-4c2d-97ca-0d9df4206e9a" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This endpoint is used to create a batch of new Customers in order for them to consume the Bud services.\n\nFor more information on Customers in the Bud platform, please refer to our handy [guide](https://docs.thisisbud.com/docs/setup-customers).\n" }, { "info": { "name": "Remove Customer V3", "type": "http" }, "http": { "method": "DELETE", "url": "https://api-sandbox.thisisbud.com/platform/v3/customers/:customer_id", "headers": [ { "name": "X-Client-Id", "value": "8711bbef-b357-4c2d-97ca-0d9df4206e9a" } ], "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "The customer identifier." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This endpoint is used to delete an existing Customer. Calling this endpoint initiates deleting all data relating to a customer returning a task id that can be used to check the status of the delete task." }, { "info": { "name": "Remove Customer By Idempotent Identifier V3", "type": "http" }, "http": { "method": "DELETE", "url": "https://api-sandbox.thisisbud.com/platform/v3/customers/idempotent-identifier/:customer_idempotent_identifier", "headers": [ { "name": "X-Client-Id", "value": "8711bbef-b357-4c2d-97ca-0d9df4206e9a" } ], "params": [ { "name": "customer_idempotent_identifier", "value": "", "type": "path", "description": "The internal client identifier, provided in the client_metadata object when creating the customer in Create Customer V3." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This endpoint is used to delete an existing Customer. Calling this endpoint initiates deleting all data relating to a customer returning a task id that can be used to check the status of the delete task." }, { "info": { "name": "Retrieve Remove Customer V3 Status", "type": "http" }, "http": { "method": "GET", "url": "https://api-sandbox.thisisbud.com/platform/v3/customers/:customer_id/:task_id", "headers": [ { "name": "X-Client-Id", "value": "8711bbef-b357-4c2d-97ca-0d9df4206e9a" } ], "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "The customer identifier." }, { "name": "task_id", "value": "", "type": "path", "description": "Bud Task identifier returned from an async task for the requested action" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Check the status and get the result of a Remove Customer V3 task.\n" }, { "info": { "name": "Create Customer", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.thisisbud.com/v1/customers", "headers": [ { "name": "X-Client-Id", "value": "8711bbef-b357-4c2d-97ca-0d9df4206e9a" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This endpoint is used to create a new Customer in order for them to consume the Bud services.\n\n**Please note: this endpoint is now deprecated, please migrate to using the POST /v2/customers endpoint.**\n" }, { "info": { "name": "Create Customer(s)", "type": "http" }, "http": { "method": "POST", "url": "https://api-sandbox.thisisbud.com/v2/customers", "headers": [ { "name": "X-Client-Id", "value": "8711bbef-b357-4c2d-97ca-0d9df4206e9a" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This endpoint is used to create one or many new Customers, in order for them to consume the Bud services." }, { "info": { "name": "Remove Customer", "type": "http" }, "http": { "method": "DELETE", "url": "https://api-sandbox.thisisbud.com/v1/customers/:customer_id", "headers": [ { "name": "X-Client-Id", "value": "8711bbef-b357-4c2d-97ca-0d9df4206e9a" } ], "params": [ { "name": "customer_id", "value": "c3339af9-2426-44d4-9c4d-ddb8fd281e23", "type": "path", "description": "A unique identifier for a Customer, as registered on Bud's platform." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This endpoint is used to delete an existing Customer. Calling this deletes all data associated with the customer including any Open Banking Consents.\n\nIf the customer with the given ID does not exist or has already been deleted, a 404 error is returned.\n" }, { "info": { "name": "Retrieve Customer Context", "type": "http" }, "http": { "method": "GET", "url": "https://api-sandbox.thisisbud.com/v1/customers/:customer_id/context", "headers": [ { "name": "X-Client-Id", "value": "8711bbef-b357-4c2d-97ca-0d9df4206e9a" } ], "params": [ { "name": "customer_id", "value": "c3339af9-2426-44d4-9c4d-ddb8fd281e23", "type": "path", "description": "A unique identifier for a Customer, as registered on Bud's platform." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieve the customer level context, i.e. a set of parameters that defines their language, region and their customer type." }, { "info": { "name": "Update Customer Context", "type": "http" }, "http": { "method": "PUT", "url": "https://api-sandbox.thisisbud.com/v1/customers/:customer_id/context", "headers": [ { "name": "X-Client-Id", "value": "8711bbef-b357-4c2d-97ca-0d9df4206e9a" } ], "params": [ { "name": "customer_id", "value": "c3339af9-2426-44d4-9c4d-ddb8fd281e23", "type": "path", "description": "A unique identifier for a Customer, as registered on Bud's platform." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates the customer context.\nAll three body parameters (region, locale, and models) will overwrite any existing values.\nIf a parameter is not provided, it's corresponding context field will be set to empty.\n" } ] } ], "bundled": true }