> For the complete documentation index, see [llms.txt](https://help.citrusad.com/retail-media-interface/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.citrusad.com/retail-media-interface/partner/cs/team-user-api/user-1/createuserteaminvite.md). # Pozvat uživatele do týmu ## Invite a user to the team > Sends an invitation to a user to join a specified team. It requires parameters such as the team's unique identifier and the email address of the user to be invited. The retailer team, identified by a unique ID, manages access and can also invite suppliers. ```json {"openapi":"3.0.0","info":{"title":"Citrus Team API","version":"v2"},"tags":[],"servers":[{"url":"https://auth..citrusad.com"}],"security":[{"TokenSecurity":[]}],"components":{"securitySchemes":{"TokenSecurity":{"description":"For accessing the API a valid JWT jwt must be passed in all queries in the 'Authorization' header. The following syntax must be used in the 'Authorization' header. (Bearer xxx.yyy.zzz)","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"v2CreateUserTeamInviteRequest":{"properties":{"inviteTeam":{"$ref":"#/components/schemas/v2InviteTeam"}},"required":["inviteTeam"],"type":"object"},"v2InviteTeam":{"properties":{"emailToInvite":{"description":"The email address of the user who will be invited to join the team.","type":"string"},"inviteUrl":{"description":"The base invitation url emailed to the user to respond to their invitation and continue the onboarding process.","type":"string"},"languageCode":{"$ref":"#/components/schemas/v2InviteEmailLanguageCode"},"managerTeamId":{"description":"The unique identifier of the retailer team. The retailer team handles access management and can send invitations to users, including suppliers.","type":"string"},"roleIds":{"description":"The team permissions. Users can be assigned either retailer or supplier permissions:\n\n- Retailer full: Provides users full access, allowing them to modify administration settings, campaigns, reviews, team manager roles, and team settings.\n- Retailer report view: Provides users with read only access to dashboards, campaigns, and reporting data.\n- Supplier full: Provides users full access, allowing them to modify administration settings, campaigns, and team settings.\n- Supplier report view: Provides users with read only access to dashboards, campaigns, and reporting data.","items":{"$ref":"#/components/schemas/authv2RoleTypes"},"type":"array"},"teamId":{"description":"A unique identifier for the team linked to the user who will receive the invitation.","type":"string"}},"required":["roleIds","teamId","emailToInvite"],"type":"object"},"v2InviteEmailLanguageCode":{"enum":["EN_US","CS_CZ","FR_FR","HU_HU","IT_IT","JA_JP","KO_KR","PT_BR","SK_SK","ES_ES"],"title":"- EN_US: English\n - CS_CZ: Czech (Czechia)\n - FR_FR: French (France)\n - HU_HU: Hungarian (Hungary)\n - IT_IT: Italian (Italy)\n - JA_JP: Japanese (Japan)\n - KO_KR: Korean (South Korea)\n - PT_BR: Portuguese (Brazil)\n - SK_SK: Slovak (Slovakia)\n - ES_ES: Spanish (Spain)","type":"string"},"authv2RoleTypes":{"enum":["ROLE_TYPES_SUPPLIER_REPORT_VIEW","ROLE_TYPES_SUPPLIER_FULL","ROLE_TYPES_RETAILER_REPORT_VIEW","ROLE_TYPES_RETAILER_FULL"],"type":"string"},"v2CreateUserTeamInviteResponse":{"properties":{"invitationToken":{"description":"The invitation_token of the team.","type":"string"}},"type":"object"},"rpcStatus":{"description":"The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).","properties":{"code":{"description":"The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].","format":"int32","type":"integer"},"details":{"description":"A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.","items":{"$ref":"#/components/schemas/protobufAny"},"type":"array"},"message":{"description":"A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\n[google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.","type":"string"}},"type":"object"},"protobufAny":{"additionalProperties":{},"description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(&foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := &pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := &pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": ,\n \"lastName\": \n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }","properties":{"@type":{"description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.","type":"string"}},"type":"object"}}},"paths":{"/v2/invite_teams":{"post":{"description":"Sends an invitation to a user to join a specified team. It requires parameters such as the team's unique identifier and the email address of the user to be invited. The retailer team, identified by a unique ID, manages access and can also invite suppliers.","operationId":"createUserTeamInvite","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2CreateUserTeamInviteRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2CreateUserTeamInviteResponse"}}},"description":"The invite user team"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}},"description":"There was a problem with input."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}},"description":"Access denied due to insufficient permissions."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}},"description":"Login failed or token not valid."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}},"description":"An unexpected error response."}},"summary":"Invite a user to the team","tags":["team"]}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://help.citrusad.com/retail-media-interface/partner/cs/team-user-api/user-1/createuserteaminvite.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.