Export (0) Print
Expand All

Defines a user invitation. When the invitation is accepted, the user's Microsoft account is linked to the specified Bing Ads customer accounts. For more information about user authentication, see Managing User Authentication with OAuth.


<xs:complexType name="UserInvitation">
  <xs:sequence>
    <xs:element minOccurs="0" name="Id" type="xs:long" />
    <xs:element minOccurs="0" name="FirstName" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="LastName" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="Email" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="CustomerId" type="xs:long" />
    <xs:element minOccurs="0" name="Role" nillable="true" type="tns:UserRole" />
    <xs:element minOccurs="0" name="AccountIds" nillable="true" type="q5:ArrayOflong" xmlns:q5="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
    <xs:element minOccurs="0" name="ExpirationDate" type="xs:dateTime" />
    <xs:element minOccurs="0" name="Lcid" type="tns:LCID" />
  </xs:sequence>
</xs:complexType>

Elements

Element

Description

Data Type

Send

AccountIds

An array of identifiers of the accounts that the user can manage. To specify that the user can manage all current and future accounts of the customer to which the user belongs, set to NULL.

Users with account level roles can be restricted to specific accounts. Users with customer level roles can access all accounts within the user’s customer, and their access cannot be restricted to specific accounts.

System_CLiX_noteNote

When attempting to restrict customer level user roles, for example Super Admin to specific accounts, the operation will not fail and the user will be granted access for all accounts within the specified customer.

long array

Optional

CustomerId

The identifier of the customer this user is invited to manage. The AccountIds element determines which customer accounts the user can manage.

long

Required

Email

The email address corresponding to the user's Microsoft account. The address can contain a maximum of 100 characters.

string

Required

ExpirationDate

The date and time that the user invitation will expire. The value is in Coordinated Universal Time (UTC).

System_CLiX_noteNote

The duration of a user invitation is subject to change, and currently limited to 30 days.

dateTime

Optional

FirstName

The first name of the user. The first name is limited to 40 characters.

string

Required

Id

A system generated unique identifier for the user invitation.

long

Read-only

LastName

The last name of the user. The last name is limited to 40 characters.

string

Required

Lcid

The locale to use when sending correspondence to the user by email or postal mail. The default is EnglishUS.

LCID

Required

Role

The user role, which determines the level of access that the user has to the accounts specified in the AccountIds element.

UserRole

Required

Requirements

CustomerManagementService.svc v9

Namespace: https://bingads.microsoft.com/Customer/v9

Community Additions

ADD
Show:
© 2015 Microsoft