REST Resource: accounts.invitations

• Resource: Invitation
  • JSON representation
• State
• Methods

Resource: Invitation

Invites a user to obtain permissions to access an Account.

JSON representation
{ "name": string, "inviteeEmail": string, "createTime": string, "expireTime": string, "completeTime": string, "role": enum (Role), "state": enum (State), "acceptUri": string }

Fields
name	string Immutable. The resource name of the invitation. Format: accounts/{account}/invitations/{invitation}.
inviteeEmail	string Required. Immutable. The email of the invitee. Example: [e-mail].
createTime	string (Timestamp format) Output only. Time when this invitation was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
expireTime	string (Timestamp format) Output only. Time when this invitation will expire. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
completeTime	string (Timestamp format) Output only. Time when this invitation was accepted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
role	enum (Role) Required. The role provided over an account when the user accepts the invitation.
state	enum (State) Output only. Invitation state. Set to PENDING on creation.
acceptUri	string Output only. URI for the invitee to accept the Invitation. This will direct users to the Waze Advertisers Dashboard to accept the invitation.

State

The state of the Invitation.

Enums
STATE_UNSPECIFIED	State unspecified.
PENDING	The invitation has not been accepted yet. This is the initial state when an invitation is created.
ACCEPTED	The invitation has been accepted by the invitee and a corresponding Access has been created. The invitation is deleted 14 days after it was accepted.

Methods
create	Creates a new invitation.
delete	Deletes an invitation.
get	Returns the requested invitation.
list	Lists the invitations the authenticated user can access for a given account, ordered by name.