All URIs are relative to https://api.phrase.com/v2
| Method | HTTP request | Description |
|---|---|---|
| InvitationCreate | Post /accounts/{account_id}/invitations | Create a new invitation |
| InvitationDelete | Delete /accounts/{account_id}/invitations/{id} | Delete an invitation |
| InvitationResend | Post /accounts/{account_id}/invitations/{id}/resend | Resend an invitation |
| InvitationShow | Get /accounts/{account_id}/invitations/{id} | Get a single invitation |
| InvitationUpdate | Patch /accounts/{account_id}/invitations/{id} | Update an invitation |
| InvitationUpdateSettings | Patch /projects/{project_id}/invitations/{id} | Update a member's invitation access |
| InvitationsList | Get /accounts/{account_id}/invitations | List invitations |
Invitation InvitationCreate(ctx, accountId, invitationCreateParameters, optional)
Create a new invitation
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.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| invitationCreateParameters | InvitationCreateParameters | ||
| optional | *InvitationCreateOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a InvitationCreateOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InvitationDelete(ctx, accountId, id, optional)
Delete an invitation
Delete an existing invitation (must not be accepted yet). Access token scope must include team.manage.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| id | string | ID | |
| optional | *InvitationDeleteOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a InvitationDeleteOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Invitation InvitationResend(ctx, accountId, id, optional)
Resend an invitation
Resend the invitation email (must not be accepted yet). Access token scope must include team.manage.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| id | string | ID | |
| optional | *InvitationResendOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a InvitationResendOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Invitation InvitationShow(ctx, accountId, id, optional)
Get a single invitation
Get details on a single invitation. Access token scope must include team.manage.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| id | string | ID | |
| optional | *InvitationShowOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a InvitationShowOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Invitation InvitationUpdate(ctx, accountId, id, invitationUpdateParameters, optional)
Update an invitation
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.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| id | string | ID | |
| invitationUpdateParameters | InvitationUpdateParameters | ||
| optional | *InvitationUpdateOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a InvitationUpdateOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Invitation InvitationUpdateSettings(ctx, projectId, id, invitationUpdateSettingsParameters, optional)
Update a member's invitation access
Update member's settings in the invitations. Access token scope must include team.manage.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectId | string | Project ID | |
| id | string | ID | |
| invitationUpdateSettingsParameters | InvitationUpdateSettingsParameters | ||
| optional | *InvitationUpdateSettingsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a InvitationUpdateSettingsOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]Invitation InvitationsList(ctx, accountId, optional)
List invitations
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.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| optional | *InvitationsListOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a InvitationsListOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) | page | optional.Int32| Page number | perPage | optional.Int32| Limit on the number of objects to be returned, between 1 and 100. 25 by default |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]