REST Resource: accounts.clients.invitations

  • ClientUserInvitation is a resource that allows authorized buyers to send email invitations to grant new users access to their Ad Exchange client buyer accounts.

  • These invitations contain essential information such as a unique invitation ID, the recipient's email address, and the associated client account ID.

  • The API provides methods to create, retrieve, and list client user invitations, facilitating user management within the authorized buyer system.

  • All fields within the ClientUserInvitation resource are mandatory unless specified as optional.

Resource: ClientUserInvitation

An invitation for a new client user to get access to the Authorized Buyers UI. All fields are required unless otherwise specified.

JSON representation 
{
  "invitationId": string,
  "email": string,
  "clientAccountId": string
}
Fields
invitationId

string (int64 format)

The unique numerical ID of the invitation that is sent to the user. The value of this field is ignored in create operations.
email

string

The email address to which the invitation is sent. Email addresses should be unique among all client users under each sponsor buyer.
clientAccountId

string (int64 format)

Numerical account ID of the client buyer that the invited user is associated with. The value of this field is ignored in create operations.

Methods

create

 Creates and sends out an email invitation to access an Ad Exchange client buyer account.

get

 Retrieves an existing client user invitation.

list

 Lists all the client users invitations for a client with a given account ID.