{ "opencollection": "1.0.0", "info": { "name": "Phrase Strings API Reference Accounts Invitations API", "version": "2.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Invitations", "type": "folder" }, "items": [ { "info": { "name": "List invitations", "type": "http" }, "http": { "method": "GET", "url": "https://api.phrase.com/v2/accounts/:account_id/invitations", "headers": [ { "name": "X-PhraseApp-OTP", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Account ID" }, { "name": "page", "value": "1", "type": "query", "description": "Page number" }, { "name": "per_page", "value": "25", "type": "query", "description": "Limit on the number of objects to be returned, between 1 and 100. 25 by default" } ] }, "docs": "List invitations for an account. It will also list the accessible resources like projects and locales the invited user has access to. In case nothing is shown the default access from the role is used. Access token scope must include `team.manage`." }, { "info": { "name": "Create a new invitation", "type": "http" }, "http": { "method": "POST", "url": "https://api.phrase.com/v2/accounts/:account_id/invitations", "headers": [ { "name": "X-PhraseApp-OTP", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Account ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Invite a person to an account. Developers and translators need `project_ids` and `locale_ids` assigned to access them. Access token scope must include `team.manage`." }, { "info": { "name": "Get a single invitation", "type": "http" }, "http": { "method": "GET", "url": "https://api.phrase.com/v2/accounts/:account_id/invitations/:id", "headers": [ { "name": "X-PhraseApp-OTP", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Account ID" }, { "name": "id", "value": "", "type": "path", "description": "ID" } ] }, "docs": "Get details on a single invitation. Access token scope must include `team.manage`." }, { "info": { "name": "Update an invitation", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.phrase.com/v2/accounts/:account_id/invitations/:id", "headers": [ { "name": "X-PhraseApp-OTP", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Account ID" }, { "name": "id", "value": "", "type": "path", "description": "ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing invitation (must not be accepted yet). The `email` cannot be updated. Developers and translators need `project_ids` and `locale_ids` assigned to access them. Access token scope must include `team.manage`." }, { "info": { "name": "Delete an invitation", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.phrase.com/v2/accounts/:account_id/invitations/:id", "headers": [ { "name": "X-PhraseApp-OTP", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Account ID" }, { "name": "id", "value": "", "type": "path", "description": "ID" } ] }, "docs": "Delete an existing invitation (must not be accepted yet). Access token scope must include `team.manage`." }, { "info": { "name": "Resend an invitation", "type": "http" }, "http": { "method": "POST", "url": "https://api.phrase.com/v2/accounts/:account_id/invitations/:id/resend", "headers": [ { "name": "X-PhraseApp-OTP", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Account ID" }, { "name": "id", "value": "", "type": "path", "description": "ID" } ] }, "docs": "Resend the invitation email (must not be accepted yet). Access token scope must include `team.manage`." }, { "info": { "name": "Update a member's invitation access", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.phrase.com/v2/projects/:project_id/invitations/:id", "headers": [ { "name": "X-PhraseApp-OTP", "value": "" } ], "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID" }, { "name": "id", "value": "", "type": "path", "description": "ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update member's settings in the invitations. Access token scope must include `team.manage`." } ] } ], "bundled": true }