{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"BadRequestExceptionResponseContent":{"properties":{"message":{"type":"string"}},"type":"object"},"Country":{"properties":{"countryCode":{"type":"string"}},"type":"object"},"CreateUserInvitationsRequestContent":{"properties":{"notifyInvitedUsers":{"description":"Indicates if an invitation email will be sent to the invited user. This email will direct users to the Amazon\nAds Console to redeem their invitation. Default value: false","type":"boolean"},"userInvitationRequests":{"description":"List of invitations to be sent to users.","items":{"$ref":"#/components/schemas/UserInvitationRequest"},"maxItems":50,"minItems":1,"type":"array"}},"required":["userInvitationRequests"],"type":"object"},"CreateUserInvitationsResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/InvitationError"},"maxItems":50,"minItems":0,"type":"array"},"successes":{"items":{"$ref":"#/components/schemas/UserInvitation"},"type":"array"}},"type":"object"},"ForbiddenExceptionResponseContent":{"properties":{"message":{"type":"string"}},"type":"object"},"GetUserInvitationResponseContent":{"properties":{"invitation":{"$ref":"#/components/schemas/UserInvitation"},"termsTypes":{"items":{"type":"string"},"type":"array"}},"type":"object"},"InternalServerExceptionResponseContent":{"properties":{"message":{"type":"string"}},"type":"object"},"InvitationError":{"properties":{"errorCode":{"type":"string"},"errorDetail":{"type":"string"},"errorMessage":{"type":"string"},"identifier":{"type":"string"}},"type":"object"},"ListUserInvitationsRequestContent":{"properties":{"maxResults":{"description":"Max results to fetch per page.","maximum":50,"minimum":1,"type":"number"},"nextToken":{"description":"Identifier of the next pagination token.","type":"string"}},"type":"object"},"ListUserInvitationsResponseContent":{"properties":{"invitations":{"items":{"$ref":"#/components/schemas/UserInvitation"},"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"Permission":{"properties":{"name":{"type":"string"}},"type":"object"},"PermissionSet":{"properties":{"customPermissionSet":{"description":"If type \u003d CUSTOM_PERMISSION_SET, indicates the permissions of the invitation.\nDifferent permissions are supported for different account types.\n  - Amazon DSP Advertising Accounts: campaign_edit, creatives_edit, reports_edit, reports_limited\n  - Sponsored Ads Accounts: campaign_edit, campaign_view, reports_view, brand_posts_edit, store_edit,\n  payment_method_edit, payment_method_view billing_edit, billing_view, user_edit\n  - Manager accounts do not support custom permissions\n  - Marketing Cloud Accounts do not support custom permissions","items":{"$ref":"#/components/schemas/Permission"},"maxItems":200,"minItems":1,"type":"array"},"role":{"$ref":"#/components/schemas/Role"},"type":{"description":"Type of permission set. Supported values: ROLE, CUSTOM_PERMISSION_SET","type":"string"}},"type":"object"},"RedeemUserInvitationRequestContent":{"properties":{"invitationId":{"description":"Identifier of the invitation to be redeemed.","type":"string"}},"required":["invitationId"],"type":"object"},"ResourceNotFoundExceptionResponseContent":{"properties":{"message":{"type":"string"}},"type":"object"},"RetryableServiceExceptionResponseContent":{"properties":{"message":{"type":"string"}},"type":"object"},"Role":{"properties":{"name":{"type":"string"}},"type":"object"},"Update":{"properties":{"invitationId":{"description":"Identifier of the invitation you want to update.","type":"string"},"state":{"description":"State to change your invitation to.\nSupport states: REVOKED, RESENT.","type":"string"}},"required":["invitationId","state"],"type":"object"},"UpdateUserInvitationsRequestContent":{"properties":{"notifyInvitedUsers":{"description":"Indicates if an invitation email will be sent to the invited user. This email will direct users to the Amazon\nAds Console to redeem their invitation. Default value: false","type":"boolean"},"updates":{"description":"List of updates to perform for a set of invitations.","items":{"$ref":"#/components/schemas/Update"},"maxItems":50,"minItems":1,"type":"array"}},"required":["updates"],"type":"object"},"UpdateUserInvitationsResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/InvitationError"},"maxItems":50,"minItems":0,"type":"array"},"successes":{"items":{"$ref":"#/components/schemas/Update"},"maxItems":50,"minItems":1,"type":"array"}},"type":"object"},"User":{"format":"password","properties":{"emailAddress":{"description":"Email address of the user to be invited","type":"string"},"userName":{"description":"Name of the user to be invited","type":"string"}},"required":["emailAddress","userName"],"type":"object"},"UserInvitation":{"properties":{"countries":{"items":{"$ref":"#/components/schemas/Country"},"maxItems":100,"minItems":1,"type":"array"},"createdAt":{"format":"double","type":"number"},"createdBy":{"type":"string"},"expiration":{"format":"double","type":"number"},"invitationId":{"type":"string"},"permissionSet":{"$ref":"#/components/schemas/PermissionSet"},"state":{"type":"string"},"targetId":{"type":"string"},"user":{"$ref":"#/components/schemas/User"}},"type":"object"},"UserInvitationRequest":{"properties":{"countries":{"description":"List of two-letter ISO 3166 country codes that the user is invited to. Only valid for invitations\nto global accounts.","items":{"$ref":"#/components/schemas/Country"},"maxItems":100,"minItems":1,"type":"array"},"permissionSet":{"$ref":"#/components/schemas/PermissionSet"},"user":{"$ref":"#/components/schemas/User"}},"type":"object"}},"securitySchemes":{}},"info":{"description":"Manage invitations for advertising accounts.","title":"Advertising Invitations","version":"3.0"},"openapi":"3.0.1","paths":{"/user-invitations":{"post":{"description":"\n\n**Authorized resource type**:\nGlobal Ad Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"account_edit\",\"manage_users\",\"user_edit\"]\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"manage_users\",\"user_edit\"]\n\n**Authorized resource type**:\nGlobal Manager Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-ManagerAccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\"]\n\n**Authorized resource type**:\nAMC Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"AMC_ADMIN\"]","operationId":"CreateUserInvitations","parameters":[{"description":"The Global Account Identifiers, DSP Identifiers, and Marketing Cloud Identifiers are passed using this header. Use `GET` method /globaladsaccounts and /dsp/advertisers to get the account ids that you have access to.\nMarketing Cloud entity IDs can be fetched from the advertising console","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The Global Account Identifiers, DSP Identifiers, and Marketing Cloud Identifiers are passed using this header. Use `GET` method /globaladsaccounts and /dsp/advertisers to get the account ids that you have access to.\nMarketing Cloud entity IDs can be fetched from the advertising console","maxLength":120,"pattern":"\\S*","type":"string"}},{"description":"The Manager Account Identifiers are passed using this header. Use `GET` method /manageraccounts to get the account ids that you have access to.","in":"header","name":"Amazon-Ads-ManagerAccountId","schema":{"description":"The Manager Account Identifiers are passed using this header. Use `GET` method /manageraccounts to get the account ids that you have access to.","maxLength":120,"pattern":"\\S*","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","maxLength":120,"pattern":"\\S*","type":"string"}},{"description":"The Profile Identifiers are passed using this header. Use `GET` method /profiles to get the account ids that you have access to.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The Profile Identifiers are passed using this header. Use `GET` method /profiles to get the account ids that you have access to.","maxLength":120,"pattern":"\\S*","type":"string"}}],"requestBody":{"content":{"application/vnd.CreateUserInvitations.v1+json":{"schema":{"$ref":"#/components/schemas/CreateUserInvitationsRequestContent"}}},"required":true},"responses":{"200":{"content":{"application/vnd.CreateUserInvitations.v1+json":{"schema":{"$ref":"#/components/schemas/CreateUserInvitationsResponseContent"}}},"description":"CreateUserInvitations 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestExceptionResponseContent"}}},"description":"BadRequestException 400 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenExceptionResponseContent"}}},"description":"ForbiddenException 403 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetryableServiceExceptionResponseContent"}}},"description":"RetryableServiceException 500 response"}},"tags":["Create User Invitations"]},"put":{"description":"\n\n**Authorized resource type**:\nGlobal Ad Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"account_edit\",\"manage_users\",\"user_edit\"]\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"manage_users\",\"user_edit\"]\n\n**Authorized resource type**:\nGlobal Manager Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-ManagerAccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\"]\n\n**Authorized resource type**:\nAMC Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"AMC_ADMIN\"]","operationId":"UpdateUserInvitations","parameters":[{"description":"The Global Account Identifiers, DSP Identifiers, and Marketing Cloud Identifiers are passed using this header. Use `GET` method /globaladsaccounts and /dsp/advertisers to get the account ids that you have access to.\nMarketing Cloud entity IDs can be fetched from the advertising console","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The Global Account Identifiers, DSP Identifiers, and Marketing Cloud Identifiers are passed using this header. Use `GET` method /globaladsaccounts and /dsp/advertisers to get the account ids that you have access to.\nMarketing Cloud entity IDs can be fetched from the advertising console","maxLength":120,"pattern":"\\S*","type":"string"}},{"description":"The Manager Account Identifiers are passed using this header. Use `GET` method /manageraccounts to get the account ids that you have access to.","in":"header","name":"Amazon-Ads-ManagerAccountId","schema":{"description":"The Manager Account Identifiers are passed using this header. Use `GET` method /manageraccounts to get the account ids that you have access to.","maxLength":120,"pattern":"\\S*","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","maxLength":120,"pattern":"\\S*","type":"string"}},{"description":"The Profile Identifiers are passed using this header. Use `GET` method /profiles to get the account ids that you have access to.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The Profile Identifiers are passed using this header. Use `GET` method /profiles to get the account ids that you have access to.","maxLength":120,"pattern":"\\S*","type":"string"}}],"requestBody":{"content":{"application/vnd.UpdateUserInvitations.v1+json":{"schema":{"$ref":"#/components/schemas/UpdateUserInvitationsRequestContent"}}},"required":true},"responses":{"200":{"content":{"application/vnd.UpdateUserInvitations.v1+json":{"schema":{"$ref":"#/components/schemas/UpdateUserInvitationsResponseContent"}}},"description":"UpdateUserInvitations 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestExceptionResponseContent"}}},"description":"BadRequestException 400 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenExceptionResponseContent"}}},"description":"ForbiddenException 403 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Update User Invitations"]}},"/user-invitations/list":{"post":{"description":"\n\n**Authorized resource type**:\nGlobal Ad Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"account_view\",\"account_edit\",\"manage_users\",\"user_edit\"]\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"manage_users\",\"user_edit\"]\n\n**Authorized resource type**:\nGlobal Manager Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-ManagerAccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"MA_ReadOnly\"]\n\n**Authorized resource type**:\nAMC Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"AMC_ADMIN\"]","operationId":"ListUserInvitations","parameters":[{"description":"The Global Account Identifiers, DSP Identifiers, and Marketing Cloud Identifiers are passed using this header. Use `GET` method /globaladsaccounts and /dsp/advertisers to get the account ids that you have access to.\nMarketing Cloud entity IDs can be fetched from the advertising console","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The Global Account Identifiers, DSP Identifiers, and Marketing Cloud Identifiers are passed using this header. Use `GET` method /globaladsaccounts and /dsp/advertisers to get the account ids that you have access to.\nMarketing Cloud entity IDs can be fetched from the advertising console","maxLength":120,"pattern":"\\S*","type":"string"}},{"description":"The Manager Account Identifiers are passed using this header. Use `GET` method /manageraccounts to get the account ids that you have access to.","in":"header","name":"Amazon-Ads-ManagerAccountId","schema":{"description":"The Manager Account Identifiers are passed using this header. Use `GET` method /manageraccounts to get the account ids that you have access to.","maxLength":120,"pattern":"\\S*","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","maxLength":120,"pattern":"\\S*","type":"string"}},{"description":"The Profile Identifiers are passed using this header. Use `GET` method /profiles to get the account ids that you have access to.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The Profile Identifiers are passed using this header. Use `GET` method /profiles to get the account ids that you have access to.","maxLength":120,"pattern":"\\S*","type":"string"}}],"requestBody":{"content":{"application/vnd.ListUserInvitations.v1+json":{"schema":{"$ref":"#/components/schemas/ListUserInvitationsRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.ListUserInvitations.v1+json":{"schema":{"$ref":"#/components/schemas/ListUserInvitationsResponseContent"}}},"description":"ListUserInvitations 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestExceptionResponseContent"}}},"description":"BadRequestException 400 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenExceptionResponseContent"}}},"description":"ForbiddenException 403 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["List User Invitations"]}},"/user-invitations/redeem":{"put":{"description":"\n\n**Requires one of these permissions**:\n[]","operationId":"RedeemUserInvitation","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","maxLength":120,"pattern":"\\S*","type":"string"}}],"requestBody":{"content":{"application/vnd.RedeemUserInvitation.v1+json":{"schema":{"$ref":"#/components/schemas/RedeemUserInvitationRequestContent"}}},"required":true},"responses":{"200":{"description":"RedeemUserInvitation 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestExceptionResponseContent"}}},"description":"BadRequestException 400 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenExceptionResponseContent"}}},"description":"ForbiddenException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Redeem User Invitation"]}},"/user-invitations/{invitationId}":{"get":{"description":"\n\n**Requires one of these permissions**:\n[]","operationId":"GetUserInvitation","parameters":[{"description":"Identifier of the invitation to be fetched.","in":"path","name":"invitationId","required":true,"schema":{"description":"Identifier of the invitation to be fetched.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","maxLength":120,"pattern":"\\S*","type":"string"}}],"responses":{"200":{"content":{"application/vnd.GetUserInvitation.v1+json":{"schema":{"$ref":"#/components/schemas/GetUserInvitationResponseContent"}}},"description":"GetUserInvitation 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestExceptionResponseContent"}}},"description":"BadRequestException 400 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenExceptionResponseContent"}}},"description":"ForbiddenException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Get User Invitations"]}}}}