github.com/phrase/openapi@v0.0.0-20240514140800-49e8a106740e/paths/invitations/update_settings.yaml (about)

     1  ---
     2  summary: Update a member's invitation access
     3  description: Update member's settings in the invitations. Access token scope must include <code>team.manage</code>.
     4  operationId: invitation/update_settings
     5  tags:
     6  - Invitations
     7  parameters:
     8  - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
     9  - "$ref": "../../parameters.yaml#/project_id"
    10  - "$ref": "../../parameters.yaml#/id"
    11  responses:
    12    '200':
    13      description: OK
    14      content:
    15        application/json:
    16          schema:
    17            "$ref": "../../schemas/invitation.yaml#/invitation"
    18      headers:
    19        X-Rate-Limit-Limit:
    20          "$ref": "../../headers.yaml#/X-Rate-Limit-Limit"
    21        X-Rate-Limit-Remaining:
    22          "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining"
    23        X-Rate-Limit-Reset:
    24          "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
    25    '400':
    26      "$ref": "../../responses.yaml#/400"
    27    '401':
    28      "$ref": "../../responses.yaml#/401"
    29    '403':
    30      "$ref": "../../responses.yaml#/403"
    31    '404':
    32      "$ref": "../../responses.yaml#/404"
    33    '429':
    34      "$ref": "../../responses.yaml#/429"
    35  x-code-samples:
    36  - lang: Curl
    37    source: |-
    38      curl "https://api.phrase.com/v2/projects/:project_id/invitations/:id" \
    39        -u USERNAME_OR_ACCESS_TOKEN \
    40        -X PATCH \
    41        -d '{"project_role":"Developer","locale_ids":["fff565db236400772368235db2c6117e","fff565db236400772368235db2c6117f"]}' \
    42        -H 'Content-Type: application/json'
    43  - lang: CLI v2
    44    source: |-
    45      phrase invitations update_settings \
    46      --project_id <project_id> \
    47      --id <id> \
    48      --data '{"project_role":"Developer","locale_ids":["fff565db236400772368235db2c6117e","fff565db236400772368235db2c6117f"]}' \
    49      --access_token <token>
    50  requestBody:
    51    required: true
    52    content:
    53      application/json:
    54        schema:
    55          type: object
    56          title: invitation/update_settings/parameters
    57          properties:
    58            project_role:
    59              description: Member role, can be any of of Manager, Developer, Translator
    60              type: string
    61              example: Developer
    62            locale_ids:
    63              description: List of locale ids the user has access to.
    64              type: array
    65              items:
    66                type: string
    67              example:
    68              - abcd1234abcd1234abcd1234
    69              - abcd1234abcd1234abcd1235
    70  x-cli-version: '2.5'