Page Comparison

Anchor

	top
	top

The Invitations API is used to access and modify the invitation objects and invitationCampaign objects on your business' account. The Invitations API is connected to the Locations, Staff, and Services APIs, as invitation campaigns are sent out for events at a particular location with a particular staff member for a particular service.

Info

title	On this page

Table of Contents

These are the endpoints that are available under the /invitations path, which lists all the different gift cards on your business' account.

Endpoint	Description
GET /invitation/{invitationUUId}	Returns a JSON object for specified invitation.
GET /invitation/invitationCampaign/{invitationCampaignId}	Returns a JSN object for specified invitationCampaign.
GET /invitationCampaign	Returns all invitationCampaign objects on a business' account in array format.
GET /invitationCampaign/{invitationCampaignId}	Returns all invitation objects for specified invitationCampaign.
POST /invitationCampaign/client/{commaSeparatedStringOfClientIds}	Sends an email invitation to specified clients. Request body/payload: Must pass an invitation campaign object in request body/payload. For these calls, you need to pass an invitation campaign object with all required fields and any fields you want to update or set filled in the body of the payload. We have an example of an invitation campaign object in the responses section below and have indicated the required fields in the object values table at the bottom of this page.
PUT /invitationCampaign	Updates an existing invitation campaign object. Can only be used to update description and expiration date.

Parameter	Type	Endpoints to be used with	Description
pageNumber	string	GET /invitationCampaign	Works with the pageSize parameter to determine how invitations get returned following a GET invitationCampaign call. The pageNumber value represents the number of pages on which the invitations that get returned appear.
pageSize	integer	GET /invitationCampaign	Works with the pageNumber parameter to determine how invitations gets returned following a GET invitationCampaign call. The pageSize value represents the number of invitations appearing on each page that gets returned.
professionalId	integer	GET /invitationCampaign	Should be set to the professionalId of person who sent the invitationCampaign to be returned.

Code Block

language	js
title	GET /invitation/{invitationId}
linenumbers	true
collapse	true

{
    "businessId": 43111,
    "clickDate": 1540317889771,
    "clicked": true,
    "completed": true,
    "completedDate": 1540317921105,
    "createdDate": 1540317840787,
    "createdUser": "JoeSchmo",
    "declineDate": null,
    "declined": false,
    "email": {Email object for email of specified invitation-see emails API page},
    "invitationCampaignId": 123733,
    "invitationUUId": "ivtce7769a717fa480a907847b99c4574d1",
    "modifiedDate": 1540317921105,
    "modifiedUser": "WebClient",
    "objectId": 5146945,
    "objectType": "CLIENT",
    "openDate": 1540317881254,
    "opened": true,
    "sent": true,
    "status": "COMPLETED",
    "unsubscribed": false
}

Code Block

language	js
title	GET /invitation/invitationCampaign/{invitationCampaignId}
linenumbers	true
collapse	true

[{
    "businessId": 43111,
    "clickDate": 1540390475194,
    "clicked": true,
    "completed": false,
    "completedDate": null,
    "createdDate": 1540390976818,
    "createdUser": "JoeSchmo",
    "declineDate": null,
    "declined": false,
    "email": {Email object for email of specified invitation-see emails API page},
    "invitationCampaignId": 124359,
    "invitationUUId": "ivt15dc6e1c815e416f85e9c6cf8bdc2118",
    "modifiedDate": 1540391025551,
    "modifiedUser": "WebClient",
    "objectId": 5146945,
    "objectType": "CLIENT",
    "openDate": null,
    "opened": false,
    "sent": true,
    "status": "CLICKED",
    "unsubscribed": false
}]

Code Block

language	js
title	GET /invitationCampaign
linenumbers	true
collapse	true

[{
    "businessId": 43111,
    "coordinatorStaffId": null,
    "createdDate": 1539962301620,
    "createdUser": "JoeSchmo",
    "description": "Campaign sent on 10/19/2018 @ 11:18AM",
    "email": null,
    "emailTemplateId": 70689,
    "employmentDurationType": null,
    "eventDefinitionList": null,
    "expireDate": null,
    "invitationCampaignId": 121587,
    "jobRequisitionId": null,
    "jobTitle": null,
    "locationId": null,
    "locationName": null,
    "modifiedDate": null,
    "modifiedUser": null,
    "parameterMap": null,
    "parameters": "{"staffId":"154514","reasonId":"255109","locationId":"157670"}",
    "professionalId": 77961,
    "reasonId": null,
    "requisitionNumber": null,
    "staffId": null,
    "status": null
}]

Code Block

language	js
title	GET /invitationCampaign/{invitationCampaignId}
linenumbers	true
collapse	true

{
    "businessId": 43111,
    "coordinatorStaffId": null,
    "createdDate": 1540391632592,
    "createdUser": "JoeSchmo",
    "description": "Campaign sent on 10/19/2018 @ 11:18AM",
    "email": null,
    "emailTemplateId": 70689,
    "employmentDurationType": null,
    "eventDefinitionList": null,
    "expireDate": 1540944000000,
    "invitationCampaignId": 1243292,
    "jobRequisitionId": null,
    "jobTitle": null,
    "locationId": 81181,
    "locationName": null,
    "modifiedDate": null,
    "modifiedUser": null,
    "parameterMap": null,
    "parameters": "{"staffId":"154514","reasonId":"255109","locationId":"157670"}",
    "professionalId": 77961,
    "reasonId": null,
    "requisitionNumber": null,
    "staffId": null,
    "status": null
}

Code Block

language	js
title	POST /invitationCampaign/client/{commaSeparatedStringOfClientIds}
linenumbers	true
collapse	true

{
    "businessId": 43111,
    "coordinatorStaffId": null,
    "createdDate": 1540306834662,
    "createdUser": "JoeSchmo",
    "description": "Campaign set on 10/23/2018 @ 11:00AM",
    "email": {Email object connected to specified invitation campaign-see emails API page},
    "emailTemplateId": 70689,
    "employmentDurationType": null,
    "eventDefinitionList": [{
        "active": true,
        "businessId": 43111,
        "createdDate": 1540391632663,
        "description": null,
        "eventActions": [{
            "actionType": "SEND_EMAIL",
            "active": true,
            "businessId": 43111,
            "createdDate": 1540391632670,
            "createdUser": "JoeSchmo",
            "emailCategoryId": null,
            "emailTemplateId": 12937,
            "eventActionId": 76757,
            "eventDefnId": 76691,
            "modifiedDate": null,
            "modifiedUser": null
        }],
        "eventDefnId": 76691,
        "eventType": {
            "eventCategory": null,
            "eventType": null,
            "eventTypeId": 9,
            "objectType": null
        }],
        "groupIdList": null,
        "locationIdList": null,
        "modifiedDate": null,
        "modifiedUser": null,
        "newStatus": "COMPLETED",
        "objectId": 124392,
        "objectType": "INVITATION_CAMPAIGN",
        "objectUUId": null,
        "oldStatus": "*",
        "professionalIdList": null,
        "reasonIdList": null,
        "triggerHours": null
    }],
    "expireDate": 1540944000000,
    "invitationCampaignId": 124392,
    "jobRequisitionId": null,
    "jobTitle": null,
    "locationId": 81181,
    "locationName": null,
    "modifiedDate": null,
    "modifiedUser": null,
    "parameterMap": {
        "locationId": "81181",
        "reasonId": "255109", 
        "staffId: "82275"
     },
    "parameters": "{"staffId":"82275","reasonId":"255109","locationId":"81181"}",
    "professionalId": 77961,
    "reasonId": 255109,
    "requisitionNumber": null,
    "staffId": 82275,
    "status": null
}

Code Block

language	js
title	PUT /invitationCampaign
linenumbers	true
collapse	true

{
    "businessId": 43111,
    "coordinatorStaffId": null,
    "createdDate": 1539956304696,
    "createdUser": "JoeSchmo",
    "description": "Campaign set on 10/19/2018 @ 9:38AM",
    "email": null,
    "emailTemplateId": 70689,
    "employmentDurationType": null,
    "eventDefinitionList": null,
    "expireDate": 1540944000000,
    "invitationCampaignId": 121455,
    "jobRequisitionId": null,
    "jobTitle": null,
    "locationId": null,
    "locationName": null,
    "modifiedDate": 1540302776156,
    "modifiedUser": "JoeSchmo",
    "parameterMap": null,
    "parameters": "{"staffId":"81651","reasonId":"153346","locationId":"157670"}",
    "professionalId": 77961,
    "reasonId": null,
    "requisitionNumber": null,
    "staffId": null,
    "status": null
}

GET /

invitations

invitationCampaign

clickDateDisplays as date specified invitation was clicked clicked

Property Name	Type	Required	Description
businessId	integer	Yes	Provides unique numeric ID for the business to which specified invitation campaign belongs.
coordinatorStaffId	integer		Provides unique numeric ID for any coordinator staff connected to specified invitation campaign.
createdDate	integer	Yes	Displays as date specified invitation campaign was created in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
createdUser	string	boolean	Flag for whether or not specified invitation should show as clicked.	completed	boolean	Flag for whether or not specified invitation should show as completed.	completedDateYes	Displays as username of the user who created specified invitation campaign.
description	string		Displays as description of specified invitation campaign.
email	object		Displays as email object connected to specified campaign.
emailTemplateId	integer		Provides unique numeric ID of email template used for specified invitation campaign.
employmentDurationType
eventDefinitionList	array		Displays as an array of eventDefinition objects.
expireDate	integer		Displays as date specified invitation was completed campaign is set to expire in milliseconds elapsed since January 1, 1970 00:00:00 UTC form..
createdDateinvitationCampaignId	integer		Displays as date specified invitation was created Provides unique numeric ID for specified invitation campaign.
jobRequisitionId
jobTitle
modifiedDate	integer		Displays as date specified invitation campaign was last modified in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
createdUsermodifiedUser	string		Displays as username of the user who created last modified specified invitation campaign.
declineDateparameterMap	integerobject		Displays as date specified invitation was declined in milliseconds elapsed since January 1, 1970 00:00:00 UTC parameters for call being made in object form.declined
parameters	boolean	Flag for whether or not specified invitation should show as declined.	email	object	Displays as email object string		Displays as string representations of parameters for call being made.
professionalId	integer		Provides unique numeric ID for any staff connected to specified invitation campaign.
invitationCampaignIdpublicVisible	integer	Provides unique numeric ID for invitation campaign connected to specified invitation.	invitationUUId	string	Provides unique alphanumeric ID for specified invitation.	modifiedDate	integer	Displays as date specified invitation was last modified in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.	modifiedUser	string	Displays as user who last modified specified invitation.	objectId	integerboolean	Flag for whether or not specified invitation campaign is visible to the public.
reasonId	integer		Provides unique numeric ID for any reason connected to specified invitation campaign.
requisitionNumber
staffId	integer		Provides unique numeric ID for any staff connected to specified invitation campaign.
status	string		Displays as status of specified invitation campaign.

GET /invitations

object connected objectTypestring the objectType of specified invitation. Has available options "CLIENT'", "STAFF", and "APPOINTMENT".Displays as date opened opened opened

Property Name	Type	Required	Description
businessId	integer	Yes	Provides unique numeric ID for	the business to which specified invitation belongs.
clickDate	integer		Displays as	openDate	integer	date specified invitation was	clicked in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
clicked	boolean		Flag for whether or not specified invitation should show as	clicked.
sentcompleted	boolean		Flag for whether or not specified invitation should show as sentcompleted.
statuscompletedDate	stringinteger		Displays as status of specified invitation. Has available options "PENDING", "CLICKED", "COMPLETED",	unsubscribed	boolean	Flag for whether or not specified invitation should show as unsubscribed.

GET /invitationCampaign

Property Name	Type	Required	Description
businessId	integer	Yes	Provides unique numeric ID for the business to which specified invitation campaign belongs.
coordinatorStaffId	integer	Provides unique numeric ID for any coordinator staff connected to specified invitation campaign.	createdDate	integer	Yesdate specified invitation was completed in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
createdDate	integer		Displays as date specified invitation campaign was created in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
createdUser	string	Yes	Displays as username of the user who created specified invitation campaign.
description	string	Displays as description of specified invitation campaign.	email	object	Displays as email object connected to specified campaign.	emailTemplateId	integer	Provides unique numeric ID of email template used for specified invitation campaign.	employmentDurationType	eventDefinitionList	array	Displays as an array of eventDefinition objects.	expireDate:00:00 UTC form.
createdUser	string		Displays as username of user who created specified invitation.
declineDate	integer		Displays as date specified invitation campaign is set to expire was declined in milliseconds elapsed since January 1, 1970 00:00:00 UTC form..form.
declined	boolean		Flag for whether or not specified invitation should show as declined.
email	object		Displays as email object connected to specified invitation.
invitationCampaignId	integer		Provides unique numeric ID for invitation campaign connected to specified invitation campaign.
jobRequisitionId	jobTitleinvitationUUId	string		Provides unique alphanumeric ID for specified invitation.
modifiedDate	integer		Displays as date specified invitation campaign was last modified in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
modifiedUser	string		Displays as username of the user who last modified specified invitation campaign.
parameterMapobjectId	object	Displays parameters for call being made in object form.	parametersinteger		Provides unique numeric ID for object connected to specified invitation.
objectType	string		Displays as string representations of parameters for call being made.	professionalId	integer	Provides unique numeric ID for any staff connected to specified invitation campaign.	publicVisible	boolean	Flag for whether or not specified invitation campaign is visible to the public.	reasonId	integer	Provides unique numeric ID for any reason connected to specified invitation campaign.	requisitionNumber	staffId	integer	Provides unique numeric ID for any staff connected to specified invitation campaignthe objectType of specified invitation. Has available options "CLIENT'", "STAFF", and "APPOINTMENT".
openDate	integer		Displays as date specified invitation was opened in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
opened	boolean		Flag for whether or not specified invitation should show as opened.
sent	boolean		Flag for whether or not specified invitation should show as sent.
status	string		Displays as status of specified invitation campaign. Has available options "PENDING", "CLICKED", "COMPLETED",
unsubscribed	boolean		Flag for whether or not specified invitation should show as unsubscribed.

Versions Compared

Old Version 37

New Version 38

Key

Invitations API Endpoints
Anchor
invoiceAPI
invoiceAPI

Invitations API Parameters

Invitations API Responses

Invitations Object Values

GET /

invitationCampaign

GET /invitations

GET /invitationCampaign

Page Comparison

Versions Compared

Old Version 37

New Version 38

Key

Invitations API Endpoints AnchorinvoiceAPIinvoiceAPI

Invitations API Parameters

Invitations API Responses

Invitations Object Values

GET /

invitationCampaign

GET /invitations

GET /invitationCampaign

Invitations API Endpoints
Anchor
invoiceAPI
invoiceAPI