adx_invitation EntityType
Send invitations to existing contacts or email addresses and assign them to web roles upon redemption.
- Entity set path:
- [organization URI]/api/data/v9.2/adx_invitations
- Base type:
- crmbaseentity
- Table type:
- Standard
- Display name:
- Invitation
- Primary key:
- adx_invitationid
- Primary name column:
- adx_name
- Operations supported:
- POST GET PATCH DELETE
Properties
Properties represent fields of data stored in the entity. Some properties are read-only.
| Name | Type | Details | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| adx_expirydate | Edm.DateTimeOffset |
The date the invitation is no longer valid for redemption. Display name: Expiry Date |
||||||||||
| adx_invitationcode | Edm.String |
Shows the user who is redeeming the invitation. Display name: Invitation Code |
||||||||||
| adx_invitationid | Edm.Guid |
Shows the entity instance. Display name: Invitation |
||||||||||
| adx_maximumredemptions | Edm.Int32 |
Display name: Maximum Redemptions |
||||||||||
| adx_name | Edm.String |
Type the name of the custom entity. Display name: Name |
||||||||||
| adx_redemptions | Edm.Int32 |
The current number of times this invitation has been redeemed. Display name: Redemptions |
||||||||||
| adx_type | Edm.Int32 |
The type of invitation. Display name: Type
Default options
|
||||||||||
| createdon | Edm.DateTimeOffset |
Shows the date and time when the record was created. Display name: Created On Read only
|
||||||||||
| importsequencenumber | Edm.Int32 |
Shows the sequence number of the import that created this record. Display name: Import Sequence Number |
||||||||||
| modifiedon | Edm.DateTimeOffset |
Shows the date and time when the record was modified. Display name: Modified On Read only
|
||||||||||
| overriddencreatedon | Edm.DateTimeOffset |
Shows the date and time that the record was migrated. Display name: Record Created On |
||||||||||
| statecode | Edm.Int32 |
Status of the Invitation Display name: Status
Default options
|
||||||||||
| statuscode | Edm.Int32 |
Select the invitation's status. Display name: Status Reason
Default options
|
||||||||||
| timezoneruleversionnumber | Edm.Int32 |
For internal use only. Display name: Time Zone Rule Version Number |
||||||||||
| utcconversiontimezonecode | Edm.Int32 |
Shows the time zone code that was in use when the record was created. Display name: UTC Conversion Time Zone Code |
||||||||||
| versionnumber | Edm.Int64 |
Version Number Display name: Version Number Read only
|
Lookup properties
Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Lookup property data.
| Name | Single-valued navigation property | Description |
|---|---|---|
| _adx_assigntoaccount_value | adx_assignToAccount |
An account record to assign the redeemed contact to. |
| _adx_invitecontact_value | adx_inviteContact |
The contact to send an invitation to. |
| _adx_invitercontact_value | adx_invitercontact |
The contact that invited. |
| _adx_redeemedcontact_value | adx_redeemedContact |
The contact associated with the redemption of this invitation. |
| _adx_redemptionworkflow_value | adx_redemptionWorkflow |
A workflow to execute on the redeeming contact. |
| _createdby_value | createdby |
Shows who created the record. |
| _createdonbehalfby_value | createdonbehalfby |
Shows who created the record on behalf of another user. |
| _modifiedby_value | modifiedby |
Shows who last updated the record. |
| _modifiedonbehalfby_value | modifiedonbehalfby |
Shows who last updated the record on behalf of another user. |
| _mspp_websiteid_value | mspp_websiteid | |
| _ownerid_value | ownerid |
Enter the user who is assigned to manage the record. This field is updated every time the record is assigned to a different user. |
| _owningbusinessunit_value | owningbusinessunit |
Shows the business unit that owns the record. |
| _owningteam_value | owningteam |
Unique identifier for the team that owns the record. |
| _owninguser_value | owninguser |
Unique identifier for the user that owns the record. |
Single-valued navigation properties
Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.
| Name | Type | Partner |
|---|---|---|
| adx_assignToAccount | account | adx_invitation_assigntoaccount |
| adx_inviteContact | contact | adx_invitation_invitecontact |
| adx_invitercontact | contact | adx_invitation_invitercontact |
| adx_redeemedContact | contact | adx_invitation_redeemedContact |
| adx_redemptionWorkflow | workflow | adx_invitation_redemptionworkflow |
| createdby | systemuser | lk_adx_invitation_createdby |
| createdonbehalfby | systemuser | lk_adx_invitation_createdonbehalfby |
| modifiedby | systemuser | lk_adx_invitation_modifiedby |
| modifiedonbehalfby | systemuser | lk_adx_invitation_modifiedonbehalfby |
| mspp_websiteid | powerpagesite | powerpagesite_mspp_websiteid_adx_invitation |
| ownerid | principal | owner_adx_invitation |
| owningbusinessunit | businessunit | business_unit_adx_invitation |
| owningteam | team | team_adx_invitation |
| owninguser | systemuser | user_adx_invitation |
Collection-valued navigation properties
Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.
| Name | Type | Partner |
|---|---|---|
| adx_invitation_ActivityPointers | activitypointer | regardingobjectid_adx_invitation |
| adx_invitation_adx_inviteredemptions | adx_inviteredemption | regardingobjectid_adx_invitation_adx_inviteredemption |
| adx_invitation_adx_portalcomments | adx_portalcomment | regardingobjectid_adx_invitation_adx_portalcomment |
| adx_invitation_Annotations | annotation | objectid_adx_invitation |
| adx_invitation_Appointments | appointment | regardingobjectid_adx_invitation_appointment |
| adx_invitation_AsyncOperations | asyncoperation | regardingobjectid_adx_invitation |
| adx_invitation_BulkDeleteFailures | bulkdeletefailure | regardingobjectid_adx_invitation |
| adx_invitation_chats | chat | regardingobjectid_adx_invitation_chat |
| adx_invitation_connections1 | connection | record1id_adx_invitation |
| adx_invitation_connections2 | connection | record2id_adx_invitation |
| adx_invitation_DuplicateBaseRecord | duplicaterecord | baserecordid_adx_invitation |
| adx_invitation_DuplicateMatchingRecord | duplicaterecord | duplicaterecordid_adx_invitation |
| adx_invitation_Emails | regardingobjectid_adx_invitation_email | |
| adx_invitation_Faxes | fax | regardingobjectid_adx_invitation_fax |
| adx_invitation_invitecontacts | contact | adx_invitation_invitecontacts |
| adx_invitation_Letters | letter | regardingobjectid_adx_invitation_letter |
| adx_invitation_MailboxTrackingFolders | mailboxtrackingfolder | regardingobjectid_adx_invitation |
| adx_invitation_mspp_webrole_powerpagecomponent | powerpagecomponent | adx_invitation_mspp_webrole_powerpagecomponent |
| adx_invitation_PhoneCalls | phonecall | regardingobjectid_adx_invitation_phonecall |
| adx_invitation_PrincipalObjectAttributeAccesses | principalobjectattributeaccess | objectid_adx_invitation |
| adx_invitation_ProcessSession | processsession | regardingobjectid_adx_invitation |
| adx_invitation_RecurringAppointmentMasters | recurringappointmentmaster | regardingobjectid_adx_invitation_recurringappointmentmaster |
| adx_invitation_redeemedcontacts | contact | adx_invitation_redeemedcontacts |
| adx_invitation_SocialActivities | socialactivity | regardingobjectid_adx_invitation_socialactivity |
| adx_invitation_SyncErrors | syncerror | regardingobjectid_adx_invitation |
| adx_invitation_Tasks | task | regardingobjectid_adx_invitation_task |
Operations
The following operations can be used with the adx_invitation entity type.
| Name | Binding |
|---|---|
| BulkRetain | Not Bound |
| CreateMultiple | Not Bound |
| DeleteMultiple | Not Bound |
| GrantAccess | Not Bound |
| IsValidStateTransition | Not Bound |
| ModifyAccess | Not Bound |
| PurgeRetainedContent | Not Bound |
| Restore | Not Bound |
| Retain | Not Bound |
| RetrievePrincipalAccess | Not Bound |
| RetrieveSharedPrincipalsAndAccess | Not Bound |
| RevokeAccess | Not Bound |
| RollbackRetain | Not Bound |
| UpdateMultiple | Not Bound |
| ValidateRetentionConfig | Not Bound |