{"items":[{"type":"link","label":"Propello Cloud API","link":"/openapi","routeSlug":"/openapi","content":{"contentType":"overview","meta":{"name":"Propello Cloud API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Propello Cloud API (3.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/openapi"}],"sectionId":"/openapi"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/overview:"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Propello API has been created to allow organisations to interact with the Propello platform. There are a lot of different options available to integrators but we will aim to introduce these over the next few sections to help you get up and running quickly."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rate limit is set to 120 calls per minute, however this can be changed upon request. Please speak to your Customer Success Manager to arrange this. You can view your current rate limit in the CMS in the group settings under the “Integration” tab."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have any questions around the integration or onboarding, please email "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:tech@propellocloud.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tech@propellocloud.com"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SDKs"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://packagist.org/packages/propellocloud/propello-php-sdk"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PHP"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.npmjs.com/package/yourperx"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JavaScript"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/openapi/section/overview:"}]}]}},{"type":"link","label":"Overview:","link":"/openapi/section/overview:","routeSlug":"/openapi/section/overview:","content":null},{"type":"group","label":"OAuth","link":"/openapi/oauth","routeSlug":"/openapi/oauth","items":[{"label":"Generate Access Tokens","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/oauth/oauth-request","routeSlug":"/openapi/oauth/oauth-request","metadata":{"seo":{"title":"Generate Access Tokens","description":"Generate Access Tokens"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OAuth-Request","name":"Generate Access Tokens","isWebhook":false,"pointer":"/paths/~1v3~1oauth~1token/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate Access Tokens","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OAuthBody"}},"schemaId":"components/schemas/OAuthBody","pointer":"/paths/~1v3~1oauth~1token/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Our API uses a client based OAuth method for authenticating. Firstly you’ll need to request an access token using your client id and secret. This token then will have to be passed in the headers for all requests."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token lifetime and reuse"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Access tokens issued by this endpoint are valid for one year from the time of issue. You should request a token once and store it securely within your application, then reuse the same token across all subsequent API calls until it expires. Do not call /v3/oauth/token on every request — the endpoint is rate-limited and treating it as part of your per-request flow will cause your integration to be throttled (HTTP 429) under normal traffic. Only request a new token when the current one is approaching expiry, has been revoked, or an API call returns 401 Unauthorized indicating the token is no longer valid."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/oauth/token","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/OAuthBody"}},"responseCodes":["200","401","405"],"pointer":"/v3/oauth/token","href":"oauth/oauth-request","openApiOperationId":"OAuth-Request","summary":"Generate Access Tokens"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/OAuthBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OAuthBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OAuthResponse"}},"schemaId":"components/schemas/OAuthResponse"},{"code":"401","description":"Not authenticated"},{"code":"405","description":"The specified method for the request is invalid."}],"pointer":"/paths/~1v3~1oauth~1token/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OAuthResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OAuthResponse"}}},{"code":"401"},{"code":"405"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/oauth/oauth-request"}],"panels":[]}]},"httpPath":"/v3/oauth/token"}],"content":{"contentType":"group","meta":{"name":"OAuth"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"OAuth","showPageActions":true},{"nodeType":"markdoc","content":"OAuth Operations"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/oauth/token","summary":"Generate Access Tokens","prefix":{"name":"post","color":"post"},"badges":[],"link":"/oauth/oauth-request","deprecated":false}]}]}]}]}},{"type":"group","label":"User","link":"/openapi/user","routeSlug":"/openapi/user","items":[{"label":"Create a new user record","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/create-user","routeSlug":"/openapi/user/create-user","metadata":{"seo":{"title":"Create a new user record","description":"Create a new user record"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-user","name":"Create a new user record","isWebhook":false,"pointer":"/paths/~1v3~1user~1create/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new user record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To authenticate requests, provide a Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can obtain a token via the Authorise endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateUserBody"}},"schemaId":"components/schemas/CreateUserBody","pointer":"/paths/~1v3~1user~1create/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When deciding on your implementation consider if there is potential for a user’s email to change. By default we do not allow users added via API to change their email address, making your system the single point of truth for these changes. Also consider how our platform will be updated with email changes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should only be used if you would like to refer to your user as their company name, generally because your database does not hold a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" & "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metadata"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional metadata can be configured within the platform by a member of the Propello team, and updated by API. Metadata can be used to segment users in the platform for a number of reasons including reporting and targeted campaigns."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Welcome email & SMS"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The group settings allow you to configure sending a new user added via the API an instant activation email and/or SMS with a tokenised URL to set their password. Once set, if you want to override this include either of the following variables in your request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":5},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"send_activation_email\": true|false"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":5},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMS"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"send_activation_sms\": true|false"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the send_activation_sms flag is set to true you need to provide a \"phone\" attribute in your request."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/user/create","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateUserBody"}},"responseCodes":["200","401","405"],"pointer":"/v3/user/create","href":"user/create-user","openApiOperationId":"create-user","summary":"Create a new user record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CreateUserBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateUserBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetUserResponse"}},"schemaId":"components/schemas/GetUserResponse"},{"code":"401","description":"Not authenticated"},{"code":"405","description":"The specified method for the request is invalid."}],"pointer":"/paths/~1v3~1user~1create/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetUserResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetUserResponse"}}},{"code":"401"},{"code":"405"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/create-user"}],"panels":[]}]},"httpPath":"/v3/user/create"},{"label":"Bulk create new user records (limit 100)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/bulk-create-user","routeSlug":"/openapi/user/bulk-create-user","metadata":{"seo":{"title":"Bulk create new user records (limit 100)","description":"Bulk create new user records (limit 100)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulk-create-user","name":"Bulk create new user records (limit 100)","isWebhook":false,"pointer":"/paths/~1v3~1user~1create~1bulk/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk create new user records (limit 100)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To authenticate requests, provide a Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can obtain a token via the Authorise endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkCreateUserBody"}},"schemaId":"components/schemas/BulkCreateUserBody","pointer":"/paths/~1v3~1user~1create~1bulk/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When deciding on your implementation consider if there is potential for a user’s email to change. By default we do not allow users added via API to change their email address, making your system the single point of truth for these changes. Also consider how our platform will be updated with email changes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should only be used if you would like to refer to your user as their company name, generally because your database does not hold a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" & "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metadata"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional metadata can be configured within the platform by a member of the Propello team, and updated by API. Metadata can be used to segment users in the platform for a number of reasons including reporting and targeted campaigns."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Welcome email"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The group settings allow you to configure sending a new user added via the API an instant activation email and/or SMS with a tokenised URL to set their password. Once set, if you want to override this include either of the following variables in your request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":5},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"send_activation_email\": true|false"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/user/create/bulk","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BulkCreateUserBody"}},"responseCodes":["202","401","405"],"pointer":"/v3/user/create/bulk","href":"user/bulk-create-user","openApiOperationId":"bulk-create-user","summary":"Bulk create new user records (limit 100)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/BulkCreateUserBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkCreateUserBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"ACCEPTED","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAcceptedResponse"}},"schemaId":"components/schemas/GetAcceptedResponse"},{"code":"401","description":"Not authenticated"},{"code":"405","description":"The specified method for the request is invalid."}],"pointer":"/paths/~1v3~1user~1create~1bulk/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/GetAcceptedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAcceptedResponse"}}},{"code":"401"},{"code":"405"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/bulk-create-user"}],"panels":[]}]},"httpPath":"/v3/user/create/bulk"},{"label":"Retrieve a users details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/get-user-detail","routeSlug":"/openapi/user/get-user-detail","metadata":{"seo":{"title":"Retrieve a users details","description":"Retrieve a users details"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-user-detail","name":"Retrieve a users details","isWebhook":false,"pointer":"/paths/~1v3~1user~1get~1{identifier}~1{identifier_value}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a users details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To authenticate requests, provide a Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can obtain a token via the Authorise endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"identifier","in":"path","schemaId":"schema_7","required":true,"example":"email"},{"name":"identifier_value","in":"path","schemaId":"schema_8","required":true,"example":"john.smith@example.org"}],"pointer":"/paths/~1v3~1user~1get~1{identifier}~1{identifier_value}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetUserBody"}},"schemaId":"components/schemas/GetUserBody","pointer":"/paths/~1v3~1user~1get~1{identifier}~1{identifier_value}/post/requestBody","description":"If accessing via an organisation level token you will need to provide an organisation group id in order to indicate which group the user belongs to."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/user/get/{identifier}/{identifier_value}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"identifier","in":"path","required":true,"example":"email","schemaId":"schema_7"},{"name":"identifier_value","in":"path","required":true,"example":"john.smith@example.org","schemaId":"schema_8"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GetUserBody"}},"responseCodes":["200","401","405"],"pointer":"/v3/user/get/{identifier}/{identifier_value}","href":"user/get-user-detail","openApiOperationId":"get-user-detail","summary":"Retrieve a users details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/GetUserBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetUserBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetUserResponse"}},"schemaId":"components/schemas/GetUserResponse"},{"code":"401","description":"Not authenticated"},{"code":"405","description":"The specified method for the request is invalid."}],"pointer":"/paths/~1v3~1user~1get~1{identifier}~1{identifier_value}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetUserResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetUserResponse"}}},{"code":"401"},{"code":"405"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/get-user-detail"}],"panels":[]}]},"httpPath":"/v3/user/get/{identifier}/{identifier_value}"},{"label":"Retrieve a list of users","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/get-user-list","routeSlug":"/openapi/user/get-user-list","metadata":{"seo":{"title":"Retrieve a list of users","description":"Retrieve a list of users"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-user-list","name":"Retrieve a list of users","isWebhook":false,"pointer":"/paths/~1v3~1user~1list/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To authenticate requests, provide a Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can obtain a token via the Authorise endpoint."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/user/list","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","405"],"pointer":"/v3/user/list","href":"user/get-user-list","openApiOperationId":"get-user-list","summary":"Retrieve a list of users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetUserListResponse"}},"schemaId":"components/schemas/GetUserListResponse"},{"code":"401","description":"Not authenticated"},{"code":"405","description":"The specified method for the request is invalid."}],"pointer":"/paths/~1v3~1user~1list/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetUserListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetUserListResponse"}}},{"code":"401"},{"code":"405"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/get-user-list"}],"panels":[]}]},"httpPath":"/v3/user/list"},{"label":"Update a user record","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/update-user","routeSlug":"/openapi/user/update-user","metadata":{"seo":{"title":"Update a user record","description":"Update a user record"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update-user","name":"Update a user record","isWebhook":false,"pointer":"/paths/~1v3~1user~1update~1{identifier}~1{identifier_value}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a user record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To authenticate requests, provide a Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can obtain a token via the Authorise endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"identifier","in":"path","schemaId":"schema_7","required":true,"example":"email"},{"name":"identifier_value","in":"path","schemaId":"schema_8","required":true,"example":"john.smith@example.org"}],"pointer":"/paths/~1v3~1user~1update~1{identifier}~1{identifier_value}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateUserBody"}},"schemaId":"components/schemas/CreateUserBody","pointer":"/paths/~1v3~1user~1update~1{identifier}~1{identifier_value}/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If accessing via an organisation level token you will need to provide an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organisation_group_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to indicate which group the user belongs to."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/user/update/{identifier}/{identifier_value}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"identifier","in":"path","required":true,"example":"email","schemaId":"schema_7"},{"name":"identifier_value","in":"path","required":true,"example":"john.smith@example.org","schemaId":"schema_8"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateUserBody"}},"responseCodes":["200","401","405"],"pointer":"/v3/user/update/{identifier}/{identifier_value}","href":"user/update-user","openApiOperationId":"update-user","summary":"Update a user record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CreateUserBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateUserBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetUserResponse"}},"schemaId":"components/schemas/GetUserResponse"},{"code":"401","description":"Not authenticated"},{"code":"405","description":"The specified method for the request is invalid."}],"pointer":"/paths/~1v3~1user~1update~1{identifier}~1{identifier_value}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetUserResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetUserResponse"}}},{"code":"401"},{"code":"405"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/update-user"}],"panels":[]}]},"httpPath":"/v3/user/update/{identifier}/{identifier_value}"},{"label":"Deactivate a user record","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/delete-user","routeSlug":"/openapi/user/delete-user","metadata":{"seo":{"title":"Deactivate a user record","description":"Deactivate a user record"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-user","name":"Deactivate a user record","isWebhook":false,"pointer":"/paths/~1v3~1user~1delete~1{identifier}~1{identifier_value}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deactivate a user record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To authenticate requests, provide a Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can obtain a token via the Authorise endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"identifier","in":"path","schemaId":"schema_7","required":true,"example":"email"},{"name":"identifier_value","in":"path","schemaId":"schema_8","required":true,"example":"john.smith@example.org"}],"pointer":"/paths/~1v3~1user~1delete~1{identifier}~1{identifier_value}/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetUserBody"}},"schemaId":"components/schemas/GetUserBody","pointer":"/paths/~1v3~1user~1delete~1{identifier}~1{identifier_value}/delete/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deleting a user, revokes their access to the platform but retains all information stored against them."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We suggest implementing a process to reactivate users if there is potential that they may return. If a request to create a user that already exists in either an active or deleted state is posted to our system, we will reject it."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If accessing via an organisation level token you will need to provide an organisation group id in order to indicate which group the user belongs to."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/user/delete/{identifier}/{identifier_value}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"identifier","in":"path","required":true,"example":"email","schemaId":"schema_7"},{"name":"identifier_value","in":"path","required":true,"example":"john.smith@example.org","schemaId":"schema_8"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GetUserBody"}},"responseCodes":["200","401","405"],"pointer":"/v3/user/delete/{identifier}/{identifier_value}","href":"user/delete-user","openApiOperationId":"delete-user","summary":"Deactivate a user record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/GetUserBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetUserBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEmptyResponse"}},"schemaId":"components/schemas/GetEmptyResponse"},{"code":"401","description":"Not authenticated"},{"code":"405","description":"The specified method for the request is invalid."}],"pointer":"/paths/~1v3~1user~1delete~1{identifier}~1{identifier_value}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetEmptyResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEmptyResponse"}}},{"code":"401"},{"code":"405"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/delete-user"}],"panels":[]}]},"httpPath":"/v3/user/delete/{identifier}/{identifier_value}"},{"label":"Restore a deactivated user record","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/restore-user","routeSlug":"/openapi/user/restore-user","metadata":{"seo":{"title":"Restore a deactivated user record","description":"Restore a deactivated user record"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"restore-user","name":"Restore a deactivated user record","isWebhook":false,"pointer":"/paths/~1v3~1user~1restore~1{identifier}~1{identifier_value}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Restore a deactivated user record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To authenticate requests, provide a Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can obtain a token via the Authorise endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"identifier","in":"path","schemaId":"schema_7","required":true,"example":"email"},{"name":"identifier_value","in":"path","schemaId":"schema_8","required":true,"example":"john.smith@example.org"}],"pointer":"/paths/~1v3~1user~1restore~1{identifier}~1{identifier_value}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetUserBody"}},"schemaId":"components/schemas/GetUserBody","pointer":"/paths/~1v3~1user~1restore~1{identifier}~1{identifier_value}/post/requestBody","description":"If accessing via an organisation level token you will need to provide an organisation group id in order to indicate which group the user belongs to."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/user/restore/{identifier}/{identifier_value}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"identifier","in":"path","required":true,"example":"email","schemaId":"schema_7"},{"name":"identifier_value","in":"path","required":true,"example":"john.smith@example.org","schemaId":"schema_8"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GetUserBody"}},"responseCodes":["200","401","405"],"pointer":"/v3/user/restore/{identifier}/{identifier_value}","href":"user/restore-user","openApiOperationId":"restore-user","summary":"Restore a deactivated user record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/GetUserBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetUserBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEmptyResponse"}},"schemaId":"components/schemas/GetEmptyResponse"},{"code":"401","description":"Not authenticated"},{"code":"405","description":"The specified method for the request is invalid."}],"pointer":"/paths/~1v3~1user~1restore~1{identifier}~1{identifier_value}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetEmptyResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEmptyResponse"}}},{"code":"401"},{"code":"405"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/restore-user"}],"panels":[]}]},"httpPath":"/v3/user/restore/{identifier}/{identifier_value}"},{"label":"Generate a single-use user login link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/login-url","routeSlug":"/openapi/user/login-url","metadata":{"seo":{"title":"Generate a single-use user login link","description":"Generate a single-use user login link"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"login-url","name":"Generate a single-use user login link","isWebhook":false,"pointer":"/paths/~1v3~1user~1login-url~1{identifier}~1{identifier_value}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate a single-use user login link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To authenticate requests, provide a Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can obtain a token via the Authorise endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"identifier","in":"path","schemaId":"schema_7","required":true,"example":"email"},{"name":"identifier_value","in":"path","schemaId":"schema_8","required":true,"example":"john.smith@example.org"}],"pointer":"/paths/~1v3~1user~1login-url~1{identifier}~1{identifier_value}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetUserBody"}},"schemaId":"components/schemas/GetUserBody","pointer":"/paths/~1v3~1user~1login-url~1{identifier}~1{identifier_value}/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It may be necessary to redirect a user to our platform and automatically authenticate them. Using this endpoint your system can receive a URL which will authenticate the user."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If accessing via an organisation level token you will need to provide an organisation group id in order to indicate which group the user belongs to."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/user/login-url/{identifier}/{identifier_value}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"identifier","in":"path","required":true,"example":"email","schemaId":"schema_7"},{"name":"identifier_value","in":"path","required":true,"example":"john.smith@example.org","schemaId":"schema_8"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GetUserBody"}},"responseCodes":["200","401","405"],"pointer":"/v3/user/login-url/{identifier}/{identifier_value}","href":"user/login-url","openApiOperationId":"login-url","summary":"Generate a single-use user login link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/GetUserBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetUserBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetLoginResponse"}},"schemaId":"components/schemas/GetLoginResponse"},{"code":"401","description":"Not authenticated"},{"code":"405","description":"The specified method for the request is invalid."}],"pointer":"/paths/~1v3~1user~1login-url~1{identifier}~1{identifier_value}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetLoginResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetLoginResponse"}}},{"code":"401"},{"code":"405"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/login-url"}],"panels":[]}]},"httpPath":"/v3/user/login-url/{identifier}/{identifier_value}"},{"label":"Create a user and return a single-use login URL","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/create-login-url","routeSlug":"/openapi/user/create-login-url","metadata":{"seo":{"title":"Create a user and return a single-use login URL","description":"Create a user and return a single-use login URL"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-login-url","name":"Create a user and return a single-use login URL","isWebhook":false,"pointer":"/paths/~1v3~1user~1create~1login-url/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a user and return a single-use login URL","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To authenticate requests, provide a Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can obtain a token via the Authorise endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateUserLoginURLBody"}},"schemaId":"components/schemas/CreateUserLoginURLBody","pointer":"/paths/~1v3~1user~1create~1login-url/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you need to create a user and automatically generate a login URL."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If accessing via an organisation level token you will need to provide an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organisation_group_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to indicate which group the user belongs to."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/user/create/login-url","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateUserLoginURLBody"}},"responseCodes":["200","401","405"],"pointer":"/v3/user/create/login-url","href":"user/create-login-url","openApiOperationId":"create-login-url","summary":"Create a user and return a single-use login URL"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CreateUserLoginURLBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateUserLoginURLBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetLoginCreateUserResponse"}},"schemaId":"components/schemas/GetLoginCreateUserResponse"},{"code":"401","description":"Not authenticated"},{"code":"405","description":"The specified method for the request is invalid."}],"pointer":"/paths/~1v3~1user~1create~1login-url/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetLoginCreateUserResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetLoginCreateUserResponse"}}},{"code":"401"},{"code":"405"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/create-login-url"}],"panels":[]}]},"httpPath":"/v3/user/create/login-url"},{"label":"Delete user and remove identifiable information","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/anonymise-user","routeSlug":"/openapi/user/anonymise-user","metadata":{"seo":{"title":"Delete user and remove identifiable information","description":"Delete user and remove identifiable information"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"anonymise-user","name":"Delete user and remove identifiable information","isWebhook":false,"pointer":"/paths/~1v3~1user~1anonymise~1{identifier}~1{identifier_value}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete user and remove identifiable information","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To authenticate requests, provide a Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can obtain a token via the Authorise endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"identifier","in":"path","schemaId":"schema_7","required":true,"example":"email"},{"name":"identifier_value","in":"path","schemaId":"schema_8","required":true,"example":"john.smith@example.org"}],"pointer":"/paths/~1v3~1user~1anonymise~1{identifier}~1{identifier_value}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AnonymiseUserBody"}},"schemaId":"components/schemas/AnonymiseUserBody","pointer":"/paths/~1v3~1user~1anonymise~1{identifier}~1{identifier_value}/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default the users UID will be maintained, if you wish to remove this you will need to pass a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maintain_uid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Please note, if you anonymise the UID you will need to retain the record ID returned if the user is to be restored at a later date."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If accessing via an organisation level token you will need to provide an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organisation_group_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to indicate which group the user belongs to."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/user/anonymise/{identifier}/{identifier_value}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"identifier","in":"path","required":true,"example":"email","schemaId":"schema_7"},{"name":"identifier_value","in":"path","required":true,"example":"john.smith@example.org","schemaId":"schema_8"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AnonymiseUserBody"}},"responseCodes":["200","401","405"],"pointer":"/v3/user/anonymise/{identifier}/{identifier_value}","href":"user/anonymise-user","openApiOperationId":"anonymise-user","summary":"Delete user and remove identifiable information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/AnonymiseUserBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AnonymiseUserBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAnonymisedUserResponse"}},"schemaId":"components/schemas/GetAnonymisedUserResponse"},{"code":"401","description":"Not authenticated"},{"code":"405","description":"The specified method for the request is invalid."}],"pointer":"/paths/~1v3~1user~1anonymise~1{identifier}~1{identifier_value}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetAnonymisedUserResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAnonymisedUserResponse"}}},{"code":"401"},{"code":"405"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/anonymise-user"}],"panels":[]}]},"httpPath":"/v3/user/anonymise/{identifier}/{identifier_value}"},{"label":"Restore previously anonymised user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/make-known-user","routeSlug":"/openapi/user/make-known-user","metadata":{"seo":{"title":"Restore previously anonymised user","description":"Restore previously anonymised user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"make-known-user","name":"Restore previously anonymised user","isWebhook":false,"pointer":"/paths/~1v3~1user~1make-known~1{identifier}~1{identifier_value}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Restore previously anonymised user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To authenticate requests, provide a Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can obtain a token via the Authorise endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"identifier","in":"path","schemaId":"schema_9","required":true,"example":"UID"},{"name":"identifier_value","in":"path","schemaId":"schema_8","required":true,"example":"ABC1234"}],"pointer":"/paths/~1v3~1user~1make-known~1{identifier}~1{identifier_value}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MakeKnownUserBody"}},"schemaId":"components/schemas/MakeKnownUserBody","pointer":"/paths/~1v3~1user~1make-known~1{identifier}~1{identifier_value}/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you wish to obtain a login url for the user when restoring, you can send a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"get_login"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"login_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value will be appended to the response."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If accessing via an organisation level token you will need to provide an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organisation_group_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to indicate which group the user belongs to."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/user/make-known/{identifier}/{identifier_value}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"identifier","in":"path","required":true,"example":"UID","schemaId":"schema_9"},{"name":"identifier_value","in":"path","required":true,"example":"ABC1234","schemaId":"schema_8"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MakeKnownUserBody"}},"responseCodes":["200","401","405"],"pointer":"/v3/user/make-known/{identifier}/{identifier_value}","href":"user/make-known-user","openApiOperationId":"make-known-user","summary":"Restore previously anonymised user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/MakeKnownUserBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MakeKnownUserBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MakeKnownUserResponse"}},"schemaId":"components/schemas/MakeKnownUserResponse"},{"code":"401","description":"Not authenticated"},{"code":"405","description":"The specified method for the request is invalid."}],"pointer":"/paths/~1v3~1user~1make-known~1{identifier}~1{identifier_value}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/MakeKnownUserResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MakeKnownUserResponse"}}},{"code":"401"},{"code":"405"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/make-known-user"}],"panels":[]}]},"httpPath":"/v3/user/make-known/{identifier}/{identifier_value}"},{"label":"Retrieve bulk users redemption stats","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/get-bulk-user-redemption-stats","routeSlug":"/openapi/user/get-bulk-user-redemption-stats","metadata":{"seo":{"title":"Retrieve bulk users redemption stats","description":"Retrieve bulk users redemption stats"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-bulk-user-redemption-stats","name":"Retrieve bulk users redemption stats","isWebhook":false,"pointer":"/paths/~1v3~1users~1redemption-stats/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve bulk users redemption stats","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To authenticate requests, provide a Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can obtain a token via the Authorise endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetBulkUserRedemptionStatsRequest"}},"schemaId":"components/schemas/GetBulkUserRedemptionStatsRequest","pointer":"/paths/~1v3~1users~1redemption-stats/post/requestBody","description":"Request to get bulk user redemption stats.\n"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/users/redemption-stats","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GetBulkUserRedemptionStatsRequest"}},"responseCodes":["200","401","405"],"pointer":"/v3/users/redemption-stats","href":"user/get-bulk-user-redemption-stats","openApiOperationId":"get-bulk-user-redemption-stats","summary":"Retrieve bulk users redemption stats"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/GetBulkUserRedemptionStatsRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetBulkUserRedemptionStatsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBulkUserRedemptionStatsResponse"}},"schemaId":"components/schemas/GetBulkUserRedemptionStatsResponse"},{"code":"401","description":"Not authenticated"},{"code":"405","description":"The specified method for the request is invalid."}],"pointer":"/paths/~1v3~1users~1redemption-stats/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetBulkUserRedemptionStatsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBulkUserRedemptionStatsResponse"}}},{"code":"401"},{"code":"405"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/get-bulk-user-redemption-stats"}],"panels":[]}]},"httpPath":"/v3/users/redemption-stats"},{"label":"Retrieve a users redemption stats","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/get-user-redemption-stats","routeSlug":"/openapi/user/get-user-redemption-stats","metadata":{"seo":{"title":"Retrieve a users redemption stats","description":"Retrieve a users redemption stats"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-user-redemption-stats","name":"Retrieve a users redemption stats","isWebhook":false,"pointer":"/paths/~1v3~1user~1stats~1{identifier}~1{identifier_value}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a users redemption stats","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To authenticate requests, provide a Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can obtain a token via the Authorise endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"identifier","in":"path","schemaId":"schema_10","required":true,"example":"UID"},{"name":"identifier_value","in":"path","schemaId":"schema_8","required":true,"example":"ABC1234"}],"pointer":"/paths/~1v3~1user~1stats~1{identifier}~1{identifier_value}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetUserRedemptionstatsBody"}},"schemaId":"components/schemas/GetUserRedemptionstatsBody","pointer":"/paths/~1v3~1user~1stats~1{identifier}~1{identifier_value}/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If accessing via an organisation level token you will need to provide an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organisation_group_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to indicate which group the user belongs to."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/user/stats/{identifier}/{identifier_value}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"identifier","in":"path","required":true,"example":"UID","schemaId":"schema_10"},{"name":"identifier_value","in":"path","required":true,"example":"ABC1234","schemaId":"schema_8"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GetUserRedemptionstatsBody"}},"responseCodes":["200","401","405"],"pointer":"/v3/user/stats/{identifier}/{identifier_value}","href":"user/get-user-redemption-stats","openApiOperationId":"get-user-redemption-stats","summary":"Retrieve a users redemption stats"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/GetUserRedemptionstatsBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetUserRedemptionstatsBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetUserRedemptionStatsResponse"}},"schemaId":"components/schemas/GetUserRedemptionStatsResponse"},{"code":"401","description":"Not authenticated"},{"code":"405","description":"The specified method for the request is invalid."}],"pointer":"/paths/~1v3~1user~1stats~1{identifier}~1{identifier_value}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetUserRedemptionStatsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetUserRedemptionStatsResponse"}}},{"code":"401"},{"code":"405"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/get-user-redemption-stats"}],"panels":[]}]},"httpPath":"/v3/user/stats/{identifier}/{identifier_value}"}],"content":{"contentType":"group","meta":{"name":"User"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User","showPageActions":true},{"nodeType":"markdoc","content":"User Operations"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/user/create","summary":"Create a new user record","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user/create-user","deprecated":false},{"title":"/v3/user/create/bulk","summary":"Bulk create new user records (limit 100)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user/bulk-create-user","deprecated":false},{"title":"/v3/user/get/{identifier}/{identifier_value}","summary":"Retrieve a users details","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user/get-user-detail","deprecated":false},{"title":"/v3/user/list","summary":"Retrieve a list of users","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user/get-user-list","deprecated":false},{"title":"/v3/user/update/{identifier}/{identifier_value}","summary":"Update a user record","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user/update-user","deprecated":false},{"title":"/v3/user/delete/{identifier}/{identifier_value}","summary":"Deactivate a user record","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/user/delete-user","deprecated":false},{"title":"/v3/user/restore/{identifier}/{identifier_value}","summary":"Restore a deactivated user record","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user/restore-user","deprecated":false},{"title":"/v3/user/login-url/{identifier}/{identifier_value}","summary":"Generate a single-use user login link","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user/login-url","deprecated":false},{"title":"/v3/user/create/login-url","summary":"Create a user and return a single-use login URL","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user/create-login-url","deprecated":false},{"title":"/v3/user/anonymise/{identifier}/{identifier_value}","summary":"Delete user and remove identifiable information","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user/anonymise-user","deprecated":false},{"title":"/v3/user/make-known/{identifier}/{identifier_value}","summary":"Restore previously anonymised user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user/make-known-user","deprecated":false},{"title":"/v3/users/redemption-stats","summary":"Retrieve bulk users redemption stats","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user/get-bulk-user-redemption-stats","deprecated":false},{"title":"/v3/user/stats/{identifier}/{identifier_value}","summary":"Retrieve a users redemption stats","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user/get-user-redemption-stats","deprecated":false}]}]}]}]}},{"type":"group","label":"Group","link":"/openapi/group","routeSlug":"/openapi/group","items":[{"label":"Get Group Details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/group/get-group","routeSlug":"/openapi/group/get-group","metadata":{"seo":{"title":"Get Group Details","description":"Get Group Details"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-group","name":"Get Group Details","isWebhook":false,"pointer":"/paths/~1v3~1group/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Group Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To authenticate requests, provide a Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can obtain a token via the Authorise endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetUserBody"}},"schemaId":"components/schemas/GetUserBody","pointer":"/paths/~1v3~1group/post/requestBody","description":"If accessing via an organisation level token you will need to provide an organisation group id in order to indicate which group you are requesting."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/group","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GetUserBody"}},"responseCodes":["200","401","405"],"pointer":"/v3/group","href":"group/get-group","openApiOperationId":"get-group","summary":"Get Group Details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/GetUserBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetUserBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetGroupResponse"}},"schemaId":"components/schemas/GetGroupResponse"},{"code":"401","description":"Not authenticated"},{"code":"405","description":"The specified method for the request is invalid."}],"pointer":"/paths/~1v3~1group/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetGroupResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetGroupResponse"}}},{"code":"401"},{"code":"405"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/group/get-group"}],"panels":[]}]},"httpPath":"/v3/group"},{"label":"Get Groups List","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/group/get-group-list","routeSlug":"/openapi/group/get-group-list","metadata":{"seo":{"title":"Get Groups List","description":"Get Groups List"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-group-list","name":"Get Groups List","isWebhook":false,"pointer":"/paths/~1v3~1group~1list/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Groups List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To authenticate requests, provide a Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can obtain a token via the Authorise endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_11"}},"schemaId":"schema_11","pointer":"/paths/~1v3~1group~1list/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/group/list","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_11"}},"responseCodes":["200","401","405"],"pointer":"/v3/group/list","href":"group/get-group-list","openApiOperationId":"get-group-list","summary":"Get Groups List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_11","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_11"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetGroupsResponse"}},"schemaId":"components/schemas/GetGroupsResponse"},{"code":"401","description":"Not authenticated"},{"code":"405","description":"The specified method for the request is invalid."}],"pointer":"/paths/~1v3~1group~1list/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetGroupsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetGroupsResponse"}}},{"code":"401"},{"code":"405"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/group/get-group-list"}],"panels":[]}]},"httpPath":"/v3/group/list"}],"content":{"contentType":"group","meta":{"name":"Group"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Group","showPageActions":true},{"nodeType":"markdoc","content":"Organisation Group Operations"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/group","summary":"Get Group Details","prefix":{"name":"post","color":"post"},"badges":[],"link":"/group/get-group","deprecated":false},{"title":"/v3/group/list","summary":"Get Groups List","prefix":{"name":"post","color":"post"},"badges":[],"link":"/group/get-group-list","deprecated":false}]}]}]}]}},{"type":"group","label":"Offer","link":"/openapi/offer","routeSlug":"/openapi/offer","items":[{"label":"Get Offer Details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/offer/get-offer","routeSlug":"/openapi/offer/get-offer","metadata":{"seo":{"title":"Get Offer Details","description":"Get Offer Details"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-offer","name":"Get Offer Details","isWebhook":false,"pointer":"/paths/~1v3~1offers~1get~1{id}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Offer Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To authenticate requests, provide a Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can obtain a token via the Authorise endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_12"}],"pointer":"/paths/~1v3~1offers~1get~1{id}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/offers/get/{id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","example":1,"schemaId":"schema_12"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","405"],"pointer":"/v3/offers/get/{id}","href":"offer/get-offer","openApiOperationId":"get-offer","summary":"Get Offer Details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOfferResponse"}},"schemaId":"components/schemas/GetOfferResponse"},{"code":"401","description":"Not authenticated"},{"code":"405","description":"The specified method for the request is invalid."}],"pointer":"/paths/~1v3~1offers~1get~1{id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetOfferResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOfferResponse"}}},{"code":"401"},{"code":"405"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/offer/get-offer"}],"panels":[]}]},"httpPath":"/v3/offers/get/{id}"},{"label":"Get Offer List","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/offer/get-offer-list","routeSlug":"/openapi/offer/get-offer-list","metadata":{"seo":{"title":"Get Offer List","description":"Get Offer List"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-offer-list","name":"Get Offer List","isWebhook":false,"pointer":"/paths/~1v3~1offers~1list/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Offer List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To authenticate requests, provide a Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can obtain a token via the Authorise endpoint."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/offers/list","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","405"],"pointer":"/v3/offers/list","href":"offer/get-offer-list","openApiOperationId":"get-offer-list","summary":"Get Offer List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOfferListResponse"}},"schemaId":"components/schemas/GetOfferListResponse"},{"code":"401","description":"Not authenticated"},{"code":"405","description":"The specified method for the request is invalid."}],"pointer":"/paths/~1v3~1offers~1list/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetOfferListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOfferListResponse"}}},{"code":"401"},{"code":"405"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/offer/get-offer-list"}],"panels":[]}]},"httpPath":"/v3/offers/list"}],"content":{"contentType":"group","meta":{"name":"Offer"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Offer","showPageActions":true},{"nodeType":"markdoc","content":"Organisation Offer Operations"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/offers/get/{id}","summary":"Get Offer Details","prefix":{"name":"post","color":"post"},"badges":[],"link":"/offer/get-offer","deprecated":false},{"title":"/v3/offers/list","summary":"Get Offer List","prefix":{"name":"post","color":"post"},"badges":[],"link":"/offer/get-offer-list","deprecated":false}]}]}]}]}},{"type":"group","label":"Credit","link":"/openapi/credit","routeSlug":"/openapi/credit","items":[{"label":"Get User Credit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/credit/get-user-credit","routeSlug":"/openapi/credit/get-user-credit","metadata":{"seo":{"title":"Get User Credit","description":"Get User Credit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-user-credit","name":"Get User Credit","isWebhook":false,"pointer":"/paths/~1v3~1credit~1{identifier}~1{identifier_value}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get User Credit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To authenticate requests, provide a Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can obtain a token via the Authorise endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"identifier","in":"path","schemaId":"schema_13","required":true,"example":"email"},{"name":"identifier_value","in":"path","schemaId":"schema_8","required":true,"example":"john.smith@example.org"}],"pointer":"/paths/~1v3~1credit~1{identifier}~1{identifier_value}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetUserCreditBody"}},"schemaId":"components/schemas/GetUserCreditBody","pointer":"/paths/~1v3~1credit~1{identifier}~1{identifier_value}/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If accessing via an organisation level token you will need to provide an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organisation_group_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to indicate which group the user belongs to."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/credit/{identifier}/{identifier_value}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"identifier","in":"path","required":true,"example":"email","schemaId":"schema_13"},{"name":"identifier_value","in":"path","required":true,"example":"john.smith@example.org","schemaId":"schema_8"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GetUserCreditBody"}},"responseCodes":["200","401","405"],"pointer":"/v3/credit/{identifier}/{identifier_value}","href":"credit/get-user-credit","openApiOperationId":"get-user-credit","summary":"Get User Credit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/GetUserCreditBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetUserCreditBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetUserCreditResponse"}},"schemaId":"components/schemas/GetUserCreditResponse"},{"code":"401","description":"Not authenticated"},{"code":"405","description":"The specified method for the request is invalid."}],"pointer":"/paths/~1v3~1credit~1{identifier}~1{identifier_value}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetUserCreditResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetUserCreditResponse"}}},{"code":"401"},{"code":"405"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit/get-user-credit"}],"panels":[]}]},"httpPath":"/v3/credit/{identifier}/{identifier_value}"}],"content":{"contentType":"group","meta":{"name":"Credit"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credit","showPageActions":true},{"nodeType":"markdoc","content":"Organisation Credit Operations"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/credit/{identifier}/{identifier_value}","summary":"Get User Credit","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit/get-user-credit","deprecated":false}]}]}]}]}},{"type":"group","label":"Orders","link":"/openapi/orders","routeSlug":"/openapi/orders","items":[{"label":"List Group Orders","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/orders/list-orders","routeSlug":"/openapi/orders/list-orders","metadata":{"seo":{"title":"List Group Orders","description":"List Group Orders"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-orders","name":"List Group Orders","isWebhook":false,"pointer":"/paths/~1v3~1orders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Group Orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To authenticate requests, provide a Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can obtain a token via the Authorise endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetOrdersBody"}},"schemaId":"components/schemas/GetOrdersBody","pointer":"/paths/~1v3~1orders/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If accessing via an organisation level token you will need to provide an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organisation_group_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to indicate which group the user belongs to."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/orders","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GetOrdersBody"}},"responseCodes":["200","401","405"],"pointer":"/v3/orders","href":"orders/list-orders","openApiOperationId":"list-orders","summary":"List Group Orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/GetOrdersBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetOrdersBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrdersResponse"}},"schemaId":"components/schemas/ListOrdersResponse"},{"code":"401","description":"Not authenticated"},{"code":"405","description":"The specified method for the request is invalid."}],"pointer":"/paths/~1v3~1orders/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListOrdersResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrdersResponse"}}},{"code":"401"},{"code":"405"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/list-orders"}],"panels":[]}]},"httpPath":"/v3/orders"},{"label":"List User Orders","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/orders/list-user-orders","routeSlug":"/openapi/orders/list-user-orders","metadata":{"seo":{"title":"List User Orders","description":"List User Orders"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-user-orders","name":"List User Orders","isWebhook":false,"pointer":"/paths/~1v3~1orders~1{identifier}~1{identifier_value}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List User Orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To authenticate requests, provide a Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can obtain a token via the Authorise endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"identifier","in":"path","schemaId":"schema_13","required":true,"example":"email"},{"name":"identifier_value","in":"path","schemaId":"schema_8","required":true,"example":"john.smith@example.org"}],"pointer":"/paths/~1v3~1orders~1{identifier}~1{identifier_value}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetOrdersBody"}},"schemaId":"components/schemas/GetOrdersBody","pointer":"/paths/~1v3~1orders~1{identifier}~1{identifier_value}/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If accessing via an organisation level token you will need to provide an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organisation_group_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to indicate which group the user belongs to."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/orders/{identifier}/{identifier_value}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"identifier","in":"path","required":true,"example":"email","schemaId":"schema_13"},{"name":"identifier_value","in":"path","required":true,"example":"john.smith@example.org","schemaId":"schema_8"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GetOrdersBody"}},"responseCodes":["200","401","405"],"pointer":"/v3/orders/{identifier}/{identifier_value}","href":"orders/list-user-orders","openApiOperationId":"list-user-orders","summary":"List User Orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/GetOrdersBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetOrdersBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrdersResponse"}},"schemaId":"components/schemas/ListOrdersResponse"},{"code":"401","description":"Not authenticated"},{"code":"405","description":"The specified method for the request is invalid."}],"pointer":"/paths/~1v3~1orders~1{identifier}~1{identifier_value}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListOrdersResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrdersResponse"}}},{"code":"401"},{"code":"405"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/list-user-orders"}],"panels":[]}]},"httpPath":"/v3/orders/{identifier}/{identifier_value}"}],"content":{"contentType":"group","meta":{"name":"Orders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Orders","showPageActions":true},{"nodeType":"markdoc","content":"Organisation Orders Operations"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/orders","summary":"List Group Orders","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/list-orders","deprecated":false},{"title":"/v3/orders/{identifier}/{identifier_value}","summary":"List User Orders","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/list-user-orders","deprecated":false}]}]}]}]}},{"type":"group","label":"Interactions","link":"/openapi/interactions","routeSlug":"/openapi/interactions","items":[{"label":"List User Interactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/interactions/get-interaction","routeSlug":"/openapi/interactions/get-interaction","metadata":{"seo":{"title":"List User Interactions","description":"List User Interactions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-interaction","name":"List User Interactions","isWebhook":false,"pointer":"/paths/~1v3~1Interactions~1list~1{identifier}~1{identifier_value}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List User Interactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To authenticate requests, provide a Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can obtain a token via the Authorise endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"identifier","in":"path","schemaId":"schema_13","required":true,"example":"email"},{"name":"identifier_value","in":"path","schemaId":"schema_8","required":true,"example":"john.smith@example.org"}],"pointer":"/paths/~1v3~1Interactions~1list~1{identifier}~1{identifier_value}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ListUserInteractionsRequestBody"}},"schemaId":"components/schemas/ListUserInteractionsRequestBody","pointer":"/paths/~1v3~1Interactions~1list~1{identifier}~1{identifier_value}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/Interactions/list/{identifier}/{identifier_value}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"identifier","in":"path","required":true,"example":"email","schemaId":"schema_13"},{"name":"identifier_value","in":"path","required":true,"example":"john.smith@example.org","schemaId":"schema_8"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ListUserInteractionsRequestBody"}},"responseCodes":["200","401","405"],"pointer":"/v3/Interactions/list/{identifier}/{identifier_value}","href":"interactions/get-interaction","openApiOperationId":"get-interaction","summary":"List User Interactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ListUserInteractionsRequestBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ListUserInteractionsRequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListUserInteractionsResponse"}},"schemaId":"components/schemas/ListUserInteractionsResponse"},{"code":"401","description":"Not authenticated"},{"code":"405","description":"The specified method for the request is invalid."}],"pointer":"/paths/~1v3~1Interactions~1list~1{identifier}~1{identifier_value}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListUserInteractionsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListUserInteractionsResponse"}}},{"code":"401"},{"code":"405"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/interactions/get-interaction"}],"panels":[]}]},"httpPath":"/v3/Interactions/list/{identifier}/{identifier_value}"},{"label":"Create User Interaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/interactions/create-interaction","routeSlug":"/openapi/interactions/create-interaction","metadata":{"seo":{"title":"Create User Interaction","description":"Create User Interaction"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-interaction","name":"Create User Interaction","isWebhook":false,"pointer":"/paths/~1v3~1Interactions~1{identifier}~1{identifier_value}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create User Interaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To authenticate requests, provide a Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can obtain a token via the Authorise endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"identifier","in":"path","schemaId":"schema_13","required":true,"example":"email"},{"name":"identifier_value","in":"path","schemaId":"schema_8","required":true,"example":"john.smith@example.org"}],"pointer":"/paths/~1v3~1Interactions~1{identifier}~1{identifier_value}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateUserInteractionsRequestBody"}},"schemaId":"components/schemas/CreateUserInteractionsRequestBody","pointer":"/paths/~1v3~1Interactions~1{identifier}~1{identifier_value}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/Interactions/{identifier}/{identifier_value}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"identifier","in":"path","required":true,"example":"email","schemaId":"schema_13"},{"name":"identifier_value","in":"path","required":true,"example":"john.smith@example.org","schemaId":"schema_8"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateUserInteractionsRequestBody"}},"responseCodes":["200","401","405"],"pointer":"/v3/Interactions/{identifier}/{identifier_value}","href":"interactions/create-interaction","openApiOperationId":"create-interaction","summary":"Create User Interaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CreateUserInteractionsRequestBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateUserInteractionsRequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateUserInteractionsResponse"}},"schemaId":"components/schemas/CreateUserInteractionsResponse"},{"code":"401","description":"Not authenticated"},{"code":"405","description":"The specified method for the request is invalid."}],"pointer":"/paths/~1v3~1Interactions~1{identifier}~1{identifier_value}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateUserInteractionsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateUserInteractionsResponse"}}},{"code":"401"},{"code":"405"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/interactions/create-interaction"}],"panels":[]}]},"httpPath":"/v3/Interactions/{identifier}/{identifier_value}"}],"content":{"contentType":"group","meta":{"name":"Interactions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Interactions","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/Interactions/list/{identifier}/{identifier_value}","summary":"List User Interactions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/interactions/get-interaction","deprecated":false},{"title":"/v3/Interactions/{identifier}/{identifier_value}","summary":"Create User Interaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/interactions/create-interaction","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/OAuthBody":{"id":"components/schemas/OAuthBody","kind":"json-schema","title":"OAuthBody","data":{"type":"object","required":["client_id","client_secret","grant_type","scope"],"properties":{"client_id":{"type":"integer","example":1},"client_secret":{"type":"string","example":"VFCcW5gYwy4RDn9hhK16DoPK6nrqvNkIPoeeyMnG"},"grant_type":{"type":"string","example":"client_credentials"},"scope":{"type":"string","example":"*"}}}},"components/schemas/GetUserBody":{"id":"components/schemas/GetUserBody","kind":"json-schema","title":"GetUserBody","data":{"type":"object","properties":{"organisation_group_id":{"type":"integer","example":1}}}},"components/schemas/GetLoginBody":{"id":"components/schemas/GetLoginBody","kind":"json-schema","title":"GetLoginBody","data":{"type":"object","properties":{"organisation_group_id":{"type":"integer","example":1}}}},"components/schemas/CreateUserBody":{"id":"components/schemas/CreateUserBody","kind":"json-schema","title":"CreateUserBody","data":{"type":"object","required":["email"],"properties":{"organisation_group_id":{"type":"integer","example":1},"email":{"type":"string","example":"john.smith@example.org"},"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Smith"},"company_name":{"type":"string","example":"Parisian Inc"},"UID":{"type":"string","example":"ABC123"},"meta":{"type":"object","properties":{"sales":{"type":"integer","example":5},"location":{"type":"string","example":"London"}}}}}},"components/schemas/CreateUserLoginURLBody":{"id":"components/schemas/CreateUserLoginURLBody","kind":"json-schema","title":"CreateUserLoginURLBody","data":{"type":"object","required":["email"],"properties":{"organisation_group_id":{"type":"integer","example":1},"email":{"type":"string","example":"john.smith@example.org"},"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Smith"},"company_name":{"type":"string","example":"Parisian Inc"},"UID":{"type":"string","example":"ABC123"},"meta":{"type":"object","properties":{"sales":{"type":"integer","example":5},"location":{"type":"string","example":"London"}}},"return_user_details":{"type":"boolean","default":false,"description":"Return the created users details. Only applicable for login url."}}}},"components/schemas/BulkCreateUserBody":{"id":"components/schemas/BulkCreateUserBody","kind":"json-schema","title":"BulkCreateUserBody","data":{"type":"object","properties":{"send_activation_email":{"type":"boolean","example":false},"data":{"type":"array","items":{"$ref":"#/components/schemas/CreateUserBody"}}}}},"components/schemas/GetOrdersBody":{"id":"components/schemas/GetOrdersBody","kind":"json-schema","title":"GetOrdersBody","data":{"type":"object","properties":{"page":{"type":"integer","example":1},"per_page":{"type":"integer","example":50,"default":50,"maximum":100,"minimum":1},"order_created_from":{"type":"string","example":"2026-01-30 00:00:00"},"order_created_to":{"type":"string","example":"2026-01-30 00:00:00"},"brand_id":{"type":"integer","example":123},"brand_name":{"type":"string","example":"apple"}}}},"components/schemas/GetUserCreditBody":{"id":"components/schemas/GetUserCreditBody","kind":"json-schema","title":"GetUserCreditBody","data":{"type":"object","properties":{"page":{"type":"integer","example":1},"per_page":{"type":"integer","example":50,"default":50,"maximum":100,"minimum":1}}}},"components/schemas/OAuthResponse":{"id":"components/schemas/OAuthResponse","kind":"json-schema","title":"OAuthResponse","data":{"type":"object","properties":{"token_type":{"type":"string","example":"Bearer"},"expires_in":{"type":"integer","example":31536000},"access_token":{"type":"string","example":"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIzMjIiLCJqdGkiOiI1MTY4ZTZkNzlhNjcyZDViZmM2ODAzZDI4MWI4NmNiNzQ1NDhkY2QzMjQ3MWI2OTM4MDhlYTNhOGFmZjU3ZGU0MmU2MDliNDkxNGRlNzM0ZCIsImlhdCI6MTczNDM0MTk2NS41MDcxMTYsIm5iZiI6MTczNDM0MTk2NS41MDcxMjEsImV4cCI6MTc2NTg3Nzk2NS4zODcxNzEsInN1YiI6IiIsInNjb3BlcyI6WyIqIl19.Q-2atcKqCsd41nqH96yCOoaz8uhrauE3tdi0MhIcVNXvTjjBIytn7LTd3g4s-GLp3WejdJnLDnabszexafA6PKlVVHZUbN2SjQMBXzm9NKI9hB4LWtLvMcmiCyod4V6m0pZC5UeF3VQHkaMz1nPOfnbfI2rf5dzED6aGB7TkN_XjgqzhGwQObyRPbtVFdl7ceUZL5rDsDEOWvDj85KRoczuJSGFAWHnPCHJXLxP6UjwNoXn1AeJ8snHwvlHHZwfXWDPBXqGrm5OYsL7Mw_B8qCCuOQbofVRaN1Yur8XxNjMejflbAnIM5tgpjmCjUhxBiWfTYi4PfCUM4UrXVLDqDmCWlqMwrTmn34jbbGxJ50D4T7eSEMjfxbzhKthrfSV3FpY5oZm8AuRKmla2diniAfrLSocgDARyOCT-blI6bG_E54YPOop1EucEVRkh2AlgMjpwOJwREBp-zfPG7SPmryiH4wcUl_2g4JUzytQxImMklECkLpruurgLTzqkRVjJW2kKwNEtccsB6YaLtD31Scf3jplXUdFoomPzKixe4x98bpvJS2sVRSIzvuJhBh9nooRrXNTFyUJzo417tFHNnFOt_a6ib23AxJ8v363SP0Eq0ql4WUSDQeM93SyPF-e-8gBrfOFZHh8C3PZr90zRacffI8bop4oUu6NgH4ia4nE"}}}},"components/schemas/GetEmptyResponse":{"id":"components/schemas/GetEmptyResponse","kind":"json-schema","title":"GetEmptyResponse","data":{"type":"object","properties":{"status":{"type":"integer","example":200},"timestamp":{"type":"string","example":"1970-01-30T00:00:00.000000Z"},"data":{"example":[]}}}},"components/schemas/GetAcceptedResponse":{"id":"components/schemas/GetAcceptedResponse","kind":"json-schema","title":"GetAcceptedResponse","data":{"type":"object","properties":{"status":{"type":"integer","example":202},"timestamp":{"type":"string","example":"1970-01-30T00:00:00.000000Z"},"data":{"example":[]}}}},"components/schemas/GetLoginResponse":{"id":"components/schemas/GetLoginResponse","kind":"json-schema","title":"GetLoginResponse","data":{"type":"object","properties":{"status":{"type":"integer","example":200},"timestamp":{"type":"string","example":"1970-01-30T00:00:00.000000Z"},"data":{"type":"object","properties":{"login_url":{"type":"string","example":"https://example.yourperx.com/auth-token/BkfEhiym5mvKYSrAp5iQ0YnRTB9mdo3r9kLXe6EuEhTPoAONLNIJ8TNzGerJVwgX"}}}}}},"components/schemas/GetLoginCreateUserResponse":{"id":"components/schemas/GetLoginCreateUserResponse","kind":"json-schema","title":"GetLoginCreateUserResponse","data":{"type":"object","properties":{"status":{"type":"integer","example":200},"timestamp":{"type":"string","example":"1970-01-30T00:00:00.000000Z"},"data":{"type":"object","properties":{"login_url":{"type":"string","example":"https://example.yourperx.com/auth-token/BkfEhiym5mvKYSrAp5iQ0YnRTB9mdo3r9kLXe6EuEhTPoAONLNIJ8TNzGerJVwgX"},"user":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable if return_user_details:true is passed in the payload"},"children":[]}]}]}],"properties":{"id":{"type":"integer","example":987654},"UID":{"type":"string","example":"ABC123"},"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Smith"},"email":{"type":"string","example":"john.smith@example.org"},"status":{"type":"string","example":"Active"},"created_at":{"type":"string","example":"1970-01-30T00:00:00.000000Z"}}}}}}}},"components/schemas/GetUserResponse":{"id":"components/schemas/GetUserResponse","kind":"json-schema","title":"GetUserResponse","data":{"type":"object","properties":{"status":{"type":"integer","example":200},"timestamp":{"type":"string","example":"1970-01-30T00:00:00.000000Z"},"data":{"type":"object","properties":{"id":{"type":"integer","example":987654},"UID":{"type":"string","example":"ABC123"},"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Smith"},"email":{"type":"string","example":"john.smith@example.org"},"status":{"type":"string","example":"Active"},"created_at":{"type":"string","example":"1970-01-30T00:00:00.000000Z"}}}}}},"components/schemas/GetUserListResponse":{"id":"components/schemas/GetUserListResponse","kind":"json-schema","title":"GetUserListResponse","data":{"type":"object","properties":{"status":{"type":"integer","example":200},"timestamp":{"type":"string","example":"1970-01-30T00:00:00.000000Z"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":987654},"UID":{"type":"string","example":"test"},"alt_uid":{"type":"string","example":"test"},"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Smith"},"email":{"type":"string","example":"john.smith@example.org"},"status":{"type":"string","example":"Active"},"last_login":{"type":"string","example":"1970-01-30T00:00:00.000000Z"},"login_count":{"type":"integer","example":0},"created_at":{"type":"string","example":"1970-01-30T00:00:00.000000Z"},"updated_at":{"type":"string","example":"1970-01-30T00:00:00.000000Z"},"deleted_at":{"type":"string","example":"1970-01-30T00:00:00.000000Z"}}}}}}},"components/schemas/ListOrdersResponse":{"id":"components/schemas/ListOrdersResponse","kind":"json-schema","title":"ListOrdersResponse","data":{"type":"object","properties":{"status":{"type":"integer","example":200},"timestamp":{"type":"string","example":"1970-01-30T00:00:00.000000Z"},"data":{"type":"object","properties":{"order_id":{"type":"integer","example":987654},"order_status":{"type":"string","example":"Complete"},"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Smith"},"email":{"type":"string","example":"john.smith@example.org"},"perk_id":{"type":"integer","example":12345},"brand":{"type":"string","example":"Apple"},"offer":{"type":"string","example":"Get 10% Off All Apple Products"},"offer_excerpt":{"type":"string","example":"Order now to receive 10% off all Apple products"},"face_value":{"type":"number","example":100},"order_total_paid":{"type":"number","example":90},"order_credit":{"type":"number","example":20},"order_currency":{"type":"string","example":"GBP"},"order_saving":{"type":"number","example":10},"group_revenue":{"type":"number","example":0}}}}}},"components/schemas/GetUserCreditResponse":{"id":"components/schemas/GetUserCreditResponse","kind":"json-schema","title":"GetUserCreditResponse","data":{"type":"object","properties":{"status":{"type":"integer","example":200},"timestamp":{"type":"string","example":"1970-01-30T00:00:00.000000Z"},"data":{"type":"object","properties":{"available":{"type":"number","example":115.5},"spent":{"type":"number","example":25},"expired":{"type":"number","example":13.5},"credits":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","example":"Available"},"amount":{"type":"number","example":50},"remaining_amount":{"type":"number","example":25,"description":"If credit item is partially spent this will indicate how much is stil availble to the user"},"expires_at":{"type":"string","example":"1970-01-30T00:00:00.000000Z"},"created_at":{"type":"string","example":"1970-01-30T00:00:00.000000Z"}}}}}},"current_page":{"type":"integer","example":1},"first_page_url":{"type":"string","example":"https://{url}/v3/users/redemption-stats?page=2"},"last_page_url":{"type":"string","example":"https://{url}/v3/users/redemption-stats?page=15"},"next_page_url":{"type":"string","example":"https://{url}/v3/users/redemption-stats?page=3"},"prev_page_url":{"type":"string","example":"https://{url}/v3/users/redemption-stats?page=1"},"from":{"type":"integer","example":4},"last_page":{"type":"integer","example":15},"path":{"type":"string","example":"https://{url}/v3/users/redemption-stats"},"per_page":{"type":"integer","example":3},"to":{"type":"integer","example":6},"total":{"type":"integer","example":45}}}},"components/schemas/GetUserRedemptionstatsBody":{"id":"components/schemas/GetUserRedemptionstatsBody","kind":"json-schema","title":"GetUserRedemptionstatsBody","data":{"type":"object","properties":{"redemption_created_from":{"type":"string","example":"1970-01-30T00:00:00.000000Z"},"redemption_created_to":{"type":"string","example":"1970-01-30T00:00:00.000000Z"}}}},"components/schemas/GetUserRedemptionStatsResponse":{"id":"components/schemas/GetUserRedemptionStatsResponse","kind":"json-schema","title":"GetUserRedemptionStatsResponse","data":{"type":"object","properties":{"status":{"type":"integer","example":200},"timestamp":{"type":"string","example":"1970-01-30T00:00:00.000000Z"},"data":{"type":"object","properties":{"all_redemptions_count":{"type":"integer","example":5},"egift_face_value":{"type":"integer","example":5},"egift_cost":{"type":"integer","example":5},"order_credit":{"type":"integer","example":5},"egift_savings":{"type":"integer","example":5}}}}}},"components/schemas/AnonymiseUserBody":{"id":"components/schemas/AnonymiseUserBody","kind":"json-schema","title":"AnonymiseUserBody","data":{"type":"object","properties":{"maintain_uid":{"type":"boolean","default":true,"example":true}}}},"components/schemas/MakeKnownUserBody":{"id":"components/schemas/MakeKnownUserBody","kind":"json-schema","title":"MakeKnownUserBody","data":{"type":"object","required":["email"],"properties":{"email":{"type":"string","example":"john.smith@example.org"},"UID":{"type":"string","example":"ABC123"},"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Smith"},"company_name":{"type":"string","example":"Smith Co Ltd."},"billing_phone":{"type":"string","example":"+441234567890"},"billing_email":{"type":"string","example":"accounts@example.org"},"billing_address_line_1":{"type":"string","example":"123 Example Road"},"billing_address_line_2":{"type":"string","example":"City District"},"billing_postcode":{"type":"string","example":"EX4 4PL"},"billing_county":{"type":"string","example":"Lancashire"},"billing_country":{"type":"string","example":"United Kingdom"},"get_login":{"type":"boolean","example":true}}}},"components/schemas/MakeKnownUserResponse":{"id":"components/schemas/MakeKnownUserResponse","kind":"json-schema","title":"MakeKnownUserResponse","data":{"type":"object","properties":{"status":{"type":"integer","example":200},"timestamp":{"type":"string","example":"1970-01-30T00:00:00.000000Z"},"data":{"type":"object","properties":{"id":{"type":"integer","example":987654},"UID":{"type":"string","example":"ABC123"},"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Smith"},"email":{"type":"string","example":"john.smith@example.org"},"created_at":{"type":"string","example":"1970-01-30T00:00:00.000000Z"},"login_url":{"type":"string","example":"https://example.yourperx.com/auth-token/BkfEhiym5mvKYSrAp5iQ0YnRTB9mdo3r9kLXe6EuEhTPoAONLNIJ8TNzGerJVwgX"}}}}}},"components/schemas/GetBulkUserRedemptionStatsResponse":{"id":"components/schemas/GetBulkUserRedemptionStatsResponse","kind":"json-schema","title":"GetBulkUserRedemptionStatsResponse","data":{"type":"object","properties":{"status":{"type":"integer","example":200},"timestamp":{"type":"string","example":"1970-01-30T00:00:00.000000Z"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":987654},"UID":{"type":"string"},"email":{"type":"string"},"all_redemptions_count":{"type":"integer","example":1},"egift_orders_count":{"type":"integer","example":2},"egift_face_value":{"type":"number","example":500},"egift_cost":{"type":"number","example":100},"egift_savings":{"type":"number","example":10}}}},"current_page":{"type":"integer","example":1},"first_page_url":{"type":"string","example":"https://{url}/v3/users/redemption-stats?page=2"},"last_page_url":{"type":"string","example":"https://{url}/v3/users/redemption-stats?page=15"},"next_page_url":{"type":"string","example":"https://{url}/v3/users/redemption-stats?page=3"},"prev_page_url":{"type":"string","example":"https://{url}/v3/users/redemption-stats?page=1"},"from":{"type":"integer","example":4},"last_page":{"type":"integer","example":15},"path":{"type":"string","example":"https://{url}/v3/users/redemption-stats"},"per_page":{"type":"integer","example":3},"to":{"type":"integer","example":6},"total":{"type":"integer","example":45}}}},"components/schemas/GetAnonymisedUserResponse":{"id":"components/schemas/GetAnonymisedUserResponse","kind":"json-schema","title":"GetAnonymisedUserResponse","data":{"type":"object","properties":{"status":{"type":"integer","example":200},"timestamp":{"type":"string","example":"1970-01-30T00:00:00.000000Z"},"data":{"type":"object","properties":{"id":{"type":"integer","example":987654},"UID":{"type":"string","example":"ABC123"},"first_name":{"type":"string","example":null},"last_name":{"type":"string","example":null},"email":{"type":"string","example":null},"created_at":{"type":"string","example":"1970-01-30T00:00:00.000000Z"}}}}}},"components/schemas/GetBulkUserRedemptionStatsRequest":{"id":"components/schemas/GetBulkUserRedemptionStatsRequest","kind":"json-schema","title":"GetBulkUserRedemptionStatsRequest","data":{"type":"object","properties":{"identifier":{"type":"string","example":"id, email"},"identifier_value":{"type":"array","example":"[123,456,789]"},"start_date":{"type":"string","example":"2026-01-01"},"end_date":{"type":"string","example":"2026-02-01"},"active_only":{"type":"boolean","example":true,"default":false,"description":"Only return users with stats"}}}},"components/schemas/GetGroupResponse":{"id":"components/schemas/GetGroupResponse","kind":"json-schema","title":"GetGroupResponse","data":{"type":"object","properties":{"status":{"type":"integer","example":200},"timestamp":{"type":"string","example":"1970-01-30T00:00:00.000000Z"},"data":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"example_org"},"display_name":{"type":"string","example":"Example Org. LTD"},"sandbox":{"type":"boolean","example":0},"locale":{"type":"string","example":"en_GB"},"timezone":{"type":"string","example":"Europe/London"},"custom_domain":{"type":"string","example":null},"subdomain":{"type":"string","example":"example"}}}}}},"components/schemas/GetGroupsResponse":{"id":"components/schemas/GetGroupsResponse","kind":"json-schema","title":"GetGroupsResponse","data":{"type":"object","properties":{"status":{"type":"integer","example":200},"timestamp":{"type":"string","example":"1970-01-30T00:00:00.000000Z"},"data":{"type":"array","example":[{"id":1,"name":"example_org","display_name":"Example Org. LTD","sandbox":0,"locale":"en_GB","timezone":"Europe/London","custom_domain":null,"subdomain":"example"},{"id":2,"name":"example_org_sandbox","display_name":"Sandbox Example Org. LTD","sandbox":1,"locale":"en_GB","timezone":"Europe/London","custom_domain":null,"subdomain":"example-sandbox"}]}}}},"components/schemas/GetOfferResponse":{"id":"components/schemas/GetOfferResponse","kind":"json-schema","title":"GetOfferResponse","data":{"type":"object","properties":{"status":{"type":"integer","example":200},"timestamp":{"type":"string","example":"1970-01-30T00:00:00.000000Z"},"data":{"type":"object","properties":{"id":{"type":"integer","example":1},"partner_id":{"type":"integer","example":1},"title":{"type":"string","example":"Offer example - get amount off."},"overview":{"type":"string","example":"<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.\r\n</p>"},"terms":{"type":"string","example":"<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.\r\n</p>"},"faq":{"type":"string","example":"<p>FAQ: Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.\r\n</p>"},"how_to_redeem":{"type":"string","example":"<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.\r\n</p>"},"offer":{"type":"string","example":"Save amount"},"redemption_in_store":{"type":"boolean","example":false},"redemption_online":{"type":"boolean","example":true},"redemption_selected_stores":{"type":"boolean","example":true},"image":{"type":"string","example":"https://example.yourperx.com/storage/perx/15/151521222306.jpg"},"offer_link":{"type":"string","example":"https://example.yourperx.com/perk/1"},"collections":{"type":"array","example":[{"id":1,"name":"Gifts"}]}}}}}},"components/schemas/GetOfferListResponse":{"id":"components/schemas/GetOfferListResponse","kind":"json-schema","title":"GetOfferListResponse","data":{"type":"object","properties":{"status":{"type":"integer","example":200},"timestamp":{"type":"string","example":"1970-01-30T00:00:00.000000Z"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":987654},"brand":{"type":"string","example":"Example"},"brand_id":{"type":"integer","example":987654},"title":{"type":"string","example":"Smith"},"overview":{"type":"string","example":"<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.\r\n</p>"},"terms":{"type":"string","example":"<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.\r\n</p>"},"faq":{"type":"string","example":"<p>FAQ: Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.\r\n</p>"},"how_to_redeem":{"type":"string","example":"<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.\r\n</p>"},"offer":{"type":"string","example":"Save amount"},"start_date":{"type":"string","example":"1970-01-30T00:00:00.000000Z"},"end_date":{"type":"string","example":"1970-01-30T00:00:00.000000Z"},"redemption_in_store":{"type":"boolean","example":false},"redemption_online":{"type":"boolean","example":true},"redemption_selected_stores":{"type":"boolean","example":true},"link":{"type":"string","example":"https://example.yourperx.com/perk/1"},"image":{"type":"string","example":"https://example.yourperx.com/storage/perx/15/151521222306.jpg"},"discount":{"type":"integer","example":0},"type":{"type":"object","properties":{"id":{"type":"integer","example":987654},"perk_id":{"type":"integer","example":987654},"voucher_code":{"type":"string","example":"sxbgd4354"},"presentation":{"type":"string","example":"text"},"redeem_url_protocol":{"type":"string","example":"https"},"redeem_url":{"type":"string","example":"https://example.com/storage/perx/15/151521222306.jpg"},"trackable":{"type":"boolean","example":1},"redeem_from_inventory":{"type":"boolean","example":false},"group_allocated_inventory":{"type":"boolean","example":true}}},"perk_type_format":{"type":"string","example":"vouchers"},"collections":{"type":"array","example":[{"id":1,"name":"Gifts"}]}}}},"current_page":{"type":"integer","example":1},"first_page_url":{"type":"string","example":"https://{url}/v3/offers/list?page=2"},"last_page_url":{"type":"string","example":"https://{url}/v3/offers/list?page=15"},"next_page_url":{"type":"string","example":"https://{url}/v3/offers/list?page=3"},"prev_page_url":{"type":"string","example":"https://{url}/v3/offers/list?page=1"},"from":{"type":"integer","example":4},"last_page":{"type":"integer","example":15},"path":{"type":"string","example":"https://{url}/v3/offers/list"},"per_page":{"type":"integer","example":3},"to":{"type":"integer","example":6},"total":{"type":"integer","example":45}}}},"components/schemas/ListUserInteractionsRequestBody":{"id":"components/schemas/ListUserInteractionsRequestBody","kind":"json-schema","title":"ListUserInteractionsRequestBody","data":{"type":"object","properties":{"page":{"type":"integer","example":1},"per_page":{"type":"integer","example":50,"default":50,"maximum":100,"minimum":1},"interactions_from":{"type":"string","example":"1970-01-30T00:00:00.000000Z"},"interactions_to":{"type":"string","example":"1970-01-30T00:00:00.000000Z"}}}},"components/schemas/ListUserInteractionsResponse":{"id":"components/schemas/ListUserInteractionsResponse","kind":"json-schema","title":"ListUserInteractionsResponse","data":{"type":"object","properties":{"status":{"type":"integer","example":200},"timestamp":{"type":"string","example":"1970-01-30T00:00:00.000000Z"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":987654},"interaction_id":{"type":"string","example":"Example"},"organisation_id":{"type":"string","example":"Smith"},"organisation_group_id":{"type":"integer","example":1},"interaction_type_id":{"type":"integer","example":1},"user_id":{"type":"integer","example":987654},"interaction_at":{"type":"string","example":"1970-01-30T00:00:00.000000Z"},"interaction_details":{"type":"object","example":{}},"created_at":{"type":"string","example":"1970-01-30T00:00:00.000000Z"},"updated_at":{"type":"string","example":"1970-01-30T00:00:00.000000Z"}}}}}}},"components/schemas/CreateUserInteractionsRequestBody":{"id":"components/schemas/CreateUserInteractionsRequestBody","kind":"json-schema","title":"CreateUserInteractionsRequestBody","data":{"type":"object","properties":{"interaction_id":{"type":"integer","example":987654},"interaction_type":{"type":"string","example":"ABC"},"interaction_at":{"type":"string","example":"1970-01-30T00:00:00.000000Z"},"interaction_details":{"type":"object","example":{}}}}},"components/schemas/CreateUserInteractionsResponse":{"id":"components/schemas/CreateUserInteractionsResponse","kind":"json-schema","title":"CreateUserInteractionsResponse","data":{"type":"object","properties":{"status":{"type":"integer","example":200},"timestamp":{"type":"string","example":"1970-01-30T00:00:00.000000Z"},"data":{"type":"array","example":[]}}}},"schema_7":{"kind":"json-schema","data":{"type":"string","enum":["id","email","UID"]},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"string"},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"string","enum":["id","UID"]},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"type":"string","enum":["id","UID","email"]},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"example":{}},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"type":"integer","example":1},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"type":"string","enum":["email","id","UID"]},"id":"schema_13"}},"exampleStore":{},"securitySchemeStore":{"BearerAuth":{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To authenticate requests, provide a Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can obtain a token via the Authorise endpoint."},"children":[]}]}]}]}},"servers":[{"url":"/_mock/openapi","isMockServer":true,"description":"Mock server"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/openapi","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi.json?download"},{"url":"/_bundle/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Propello Cloud API","description":"# Overview:\nThe Propello API has been created to allow organisations to interact with the Propello platform. There are a lot of different options available to integrators but we will aim to introduce these over the next few sections to help you get up and running quickly.\n<br><br>\nThe rate limit is set to 120 calls per minute, however this can be changed upon request. Please speak to your Customer Success Manager to arrange this. You can view your current rate limit in the CMS in the group settings under the “Integration” tab.\n<br><br>\nIf you have any questions around the integration or onboarding, please email [tech@propellocloud.com](mailto:tech@propellocloud.com)\n<br><br>\n| SDKs |\n|------|\n| [PHP](https://packagist.org/packages/propellocloud/propello-php-sdk) |\n| [JavaScript](https://www.npmjs.com/package/yourperx) |\n"}},"baseSlug":"/openapi","routesMapping":{}}