SearchUserInvitations Service Operation - Customer Management

Searches for user invitations that match the request criteria.

This operation returns all pending invitations, whether or not they have expired. Accepted invitations are not included in the response.

Request Elements

The SearchUserInvitationsRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

Element	Description	Data Type
Predicates	Determines the conditions that all must be met to return user invitations. You must include exactly one predicate. For details about each supported predicate Field value see Predicate Remarks.	Predicate array

Request Header Elements

Element	Description	Data Type
AuthenticationToken	The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. For more information see Authentication with OAuth.	string
DeveloperToken	The developer token used to access the Bing Ads API. For more information see Get a Developer Token.	string
Password	This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials.	string
UserName	This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials.	string

Response Elements

The SearchUserInvitationsResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.

Response Body Elements

Element	Description	Data Type
UserInvitations	A list of user invitations that meet the specified criteria.	UserInvitation array

Response Header Elements

Element	Description	Data Type
TrackingId	The identifier of the log entry that contains the details of the API call.	string

Request SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP request. For supported types that you can use with this service operation, see the Request Body Elements reference above.

<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/Customer/v13">
    <Action mustUnderstand="1">SearchUserInvitations</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <SearchUserInvitationsRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <Predicates xmlns:e545="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e545:Predicate>
          <e545:Field i:nil="false">ValueHere</e545:Field>
          <e545:Operator>ValueHere</e545:Operator>
          <e545:Value i:nil="false">ValueHere</e545:Value>
        </e545:Predicate>
      </Predicates>
    </SearchUserInvitationsRequest>
  </s:Body>
</s:Envelope>

Response SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP response.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/Customer/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <SearchUserInvitationsResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <UserInvitations xmlns:e546="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e546:UserInvitation>
          <e546:Id>ValueHere</e546:Id>
          <e546:FirstName d4p1:nil="false">ValueHere</e546:FirstName>
          <e546:LastName d4p1:nil="false">ValueHere</e546:LastName>
          <e546:Email d4p1:nil="false">ValueHere</e546:Email>
          <e546:CustomerId>ValueHere</e546:CustomerId>
          <e546:RoleId>ValueHere</e546:RoleId>
          <e546:AccountIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:long>ValueHere</a1:long>
          </e546:AccountIds>
          <e546:ExpirationDate>ValueHere</e546:ExpirationDate>
          <e546:Lcid>ValueHere</e546:Lcid>
        </e546:UserInvitation>
      </UserInvitations>
    </SearchUserInvitationsResponse>
  </s:Body>
</s:Envelope>

Code Syntax

The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.

public async Task<SearchUserInvitationsResponse> SearchUserInvitationsAsync(
	IList<Predicate> predicates)
{
	var request = new SearchUserInvitationsRequest
	{
		Predicates = predicates
	};

	return (await CustomerManagementService.CallAsync((s, r) => s.SearchUserInvitationsAsync(r), request));
}

static SearchUserInvitationsResponse searchUserInvitations(
	ArrayOfPredicate predicates) throws RemoteException, Exception
{
	SearchUserInvitationsRequest request = new SearchUserInvitationsRequest();

	request.setPredicates(predicates);

	return CustomerManagementService.getService().searchUserInvitations(request);
}

static function SearchUserInvitations(
	$predicates)
{

	$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];

	$request = new SearchUserInvitationsRequest();

	$request->Predicates = $predicates;

	return $GLOBALS['CustomerManagementProxy']->GetService()->SearchUserInvitations($request);
}

response=customermanagement_service.SearchUserInvitations(
	Predicates=Predicates)

Requirements

Service: CustomerManagementService.svc v13
Namespace: https://bingads.microsoft.com/Customer/v13

Request Url

Production URL

https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/UserInvitations/Search

Sandbox URL

https://clientcenter.api.sandbox.bingads.microsoft.com/CustomerManagement/v13/UserInvitations/Search

Request Elements

The SearchUserInvitationsRequest object defines the body and header elements of the service operation request.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

Element	Description	Data Type
Predicates	Determines the conditions that all must be met to return user invitations. You must include exactly one predicate. For details about each supported predicate Field value see Predicate Remarks.	Predicate array

Request Header Elements

Element	Description	Data Type
Authorization	The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. Please ensure that the token is prefixed with "Bearer ", this is necessary for proper authentication. For more information see Authentication with OAuth.	string
DeveloperToken	The developer token used to access the Bing Ads API. For more information see Get a Developer Token.	string
Password	This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials.	string
UserName	This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials.	string

Response Elements

The SearchUserInvitationsResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response JSON.

Response Body Elements

Element	Description	Data Type
UserInvitations	A list of user invitations that meet the specified criteria.	UserInvitation array

Response Header Elements

Element	Description	Data Type
TrackingId	The identifier of the log entry that contains the details of the API call.	string

Request JSON

This template was generated by a tool to show the body and header elements for the JSON request. For supported types that you can use with this service operation, see the Request Body Elements reference above.

{
  "Predicates": [
    {
      "Field": "ValueHere",
      "Operator": "ValueHere",
      "Value": "ValueHere"
    }
  ]
}

Response JSON

This template was generated by a tool to show the body and header elements for the JSON response.

{
  "UserInvitations": [
    {
      "AccountIds": [
        "LongValueHere"
      ],
      "CustomerId": "LongValueHere",
      "Email": "ValueHere",
      "ExpirationDate": "ValueHere",
      "FirstName": "ValueHere",
      "Id": "LongValueHere",
      "LastName": "ValueHere",
      "Lcid": "ValueHere",
      "RoleId": IntValueHere
    }
  ]
}

Code Syntax

To call REST API through SDKs, you need to upgrade SDK to a certain version and configure the system parameters.The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.

public async Task<SearchUserInvitationsResponse> SearchUserInvitationsAsync(
	IList<Predicate> predicates)
{
	var request = new SearchUserInvitationsRequest
	{
		Predicates = predicates
	};

	return (await CustomerManagementService.CallAsync((s, r) => s.SearchUserInvitationsAsync(r), request));
}

static SearchUserInvitationsResponse searchUserInvitations(
	ArrayOfPredicate predicates) throws RemoteException, Exception
{
	SearchUserInvitationsRequest request = new SearchUserInvitationsRequest();

	request.setPredicates(predicates);

	return CustomerManagementService.getService().searchUserInvitations(request);
}

static function SearchUserInvitations(
	$predicates)
{

	$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];

	$request = new SearchUserInvitationsRequest();

	$request->Predicates = $predicates;

	return $GLOBALS['CustomerManagementProxy']->GetService()->SearchUserInvitations($request);
}

response=customermanagement_service.SearchUserInvitations(
	Predicates=Predicates)