Page Comparison

Anchortoptop

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 the specified invitation.
GET /invitation/invitationCampaign/{invitationCampaignId}	Returns a JSN JSON object for the 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/{clientIdList}	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.
POST /invitationCampaign/staff/{staffIdList}	Sends an email invitation to a staff to create an appointment. 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. Request body/payload: Must pass an invitation campaign object with all fields you want to change filled in.

Data points passed on in the request URL portion of the API call that are used to filter the data being requested.

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 BlocklanguagejstitleGET /invitation/{invitationId

The objects below represent the minimum viable objects to pass that are needed to send an invitations object. Check whether or not a property can be written to by looking at the Object Values table below to see if the property is writable.

Code Block

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

{
    "businessId": 43111,
    "clickDatedescription": 1540317889771,"Campaign for    "clicked": trueSparkles, J, Cat Grooming sent  "completed": trueon 05/09/2023 @ 11:45AM",
    "completedDateemail": 1540317921105,
    "createdDate": 1540317840787,
    "createdUser": "JoeSchmo"{Email object for email of specified invitation campaign - for more info, see Emails API page},
    "declineDateemailTemplateId": null217246,
    "declinedeventDefinitionList": false[],
    "emailparameterMap": {Email
object for email of specified invitation-see emails API page}, "clientId": 6444669,
        "invitationCampaignIdcoordStaffId": 12373377961,
        "invitationUUIdjobId": "ivtce7769a717fa480a907847b99c4574d1",57804,
        "modifiedDatejobRequisitionId": 154031792110562883,
        "modifiedUserlocationId": "WebClient",495584,
        "objectIdreasonId": 5146945255109,
        "objectTyperequisitionNumber": "CLIENT1",
    "openDate": 1540317881254,
    "openedstaffId": true77961,
    "sent": true},
    "statusprofessionalId": 77961,
	"COMPLETEDappointmentIntentId": 1234,
    "unsubscribedstatus": falsenull
}

Code Block

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

[{
    "businessId": 43111,
    "clickDatecalendarId": 1540390475194null,
    "clickedcoordinatorStaffId": truenull,
    "completedcreatedDate": false1684245327502,
    "completedDatecreatedUser": null"JoeSchmo",
    "createdDatedescription": 1540390976818 "Campaign for Sparkles, J, Cat Grooming sent  "createdUser": "JoeSchmo"on 05/16/2023 @ 9:55AM",
    "declineDatedisclaimerFormUUid": null,
    "declinedemail": falsenull,
    "emailemailTemplateId": {Email217246,
object for email of specified invitation-see emails API page} "employmentDurationType": null,
    "invitationCampaignIdeventDefinitionList": 124359null,
    "invitationUUIdexpireDate": "ivt15dc6e1c815e416f85e9c6cf8bdc21182023-05-31",
    "modifiedDateinvitationCampaignId": 1540391025551673515,
    "modifiedUserjobRequisitionId": "WebClient"null,
    "objectIdjobTitle": 5146945null,
    "objectTypelocationId": "CLIENT"null,
    "openDatelocationName": null,
    "openedmodifiedDate": falsenull,
    "sentmodifiedUser": truenull,
    "statusparameterMap": "CLICKED"null,
    "unsubscribed": false
}]

Code Block

language	js
title	GET /invitationCampaign
linenumbers	true
collapse	true

[{
    "businessId": 43111,
    "calendarId": nullparameters": "{\"staffId\":\"77961\",\"coordStaffId\":\"77961\",\"reasonId\":\"255109\",\"locationId\":\"495584\",\"jobId\":\"57804\",\"requisitionNumber\":\"1\",\"jobRequisitionId\":\"62883\"}",
    "professionalId": 77961,
	"appointmentIntentId": 1234,
    "reasonId": null,
    "requisitionNumber": null,
    "staffId": null,
    "status": null,
    "waitListId": null
}

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 - for more info, 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 - for more info, 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,
    "calendarId": null,
    "coordinatorStaffId": null,
    "createdDate": 1539962301620,
    "createdUser": "JoeSchmo",
    "description": "Campaign sent on 10/19/2018 @ 11:18AM",
    "disclaimerFormUUid": null,
    "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\":\"77961\",\"coordStaffId\":\"298660\",\"reasonId\":\"434637\",\"locationId\":\"81181\",\"jobId\":\"67044\",\"clientId\":\"5360110\",\"requisitionNumber\":\"7\",\"jobRequisitionId\":\"72420\"}",
    "coordinatorStaffIdprofessionalId": null77961,
    "createdDatereasonId": 1539962301620null,
    "createdUserrequisitionNumber": "JoeSchmo"null,
    "descriptionstaffId": "Campaign sent on 10/19/2018 @ 11:18AM"null,
    "emailstatus": null,
    "emailTemplateIdwaitlistId": 70689,null
}]

Code Block

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

[{
    "employmentDurationTypebusinessId": null43111,
    "eventDefinitionListcoordinatorStaffId": null,
    "expireDatecreatedDate": null1540391632592,
    "invitationCampaignIdcreatedUser": 121587"JoeSchmo",
    "jobRequisitionIddescription": null,"Campaign sent on 10/19/2018 @ "jobTitle": null11:18AM",
    "locationIddisclaimerFormUUid": null,
    "locationNameemail": null,
    "modifiedDateemailTemplateId": null70689,
    "modifiedUseremploymentDurationType": null,
    "parameterMapeventDefinitionList": null,
    "parametersexpireDate": "{"staffId":"154514","reasonId":"255109","locationId":"157670"}",1540944000000,
    "professionalIdinvitationCampaignId": 779611243292,
    "reasonIdjobRequisitionId": null,
    "requisitionNumberjobTitle": null,
    "staffIdlocationId": null81181,
    "statuslocationName": null
}]

Code Block

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

{,
    "businessIdmodifiedDate": 43111null,
    "coordinatorStaffIdmodifiedUser": null,
    "createdDate"parameterMap: 1540391632592null,
    "createdUserparameters": "JoeSchmo",
    "description": "Campaign sent on 10/19/2018 @ 11:18AM",
    "email": null,
    "emailTemplateId": 70689,
    "employmentDurationType": null,
    "eventDefinitionList": null{\"staffId\":\"77961\",\"coordStaffId\":\"298660\",\"reasonId\":\"434637\",\"locationId\":\"81181\",\"jobId\":\"67044\",\"clientId\":\"5360110\",\"requisitionNumber\":\"7\",\"jobRequisitionId\":\"72420\"}",
    "expireDateprofessionalId": 154094400000077961,
    "invitationCampaignIdreasonId": 1243292null,
    "jobRequisitionIdrequisitionNumber": null,
    "jobTitlestaffId": null,
    "locationIdstatus": 81181null,
    "locationNamewaitlistId": null,
}]

Code Block

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

{
    "modifiedDatebusinessId": null43111,
    "modifiedUsercalendarId": null,
    "parameterMapcoordinatorStaffId": null77961,
    "parameterscreatedDate": "{"staffId":"154514","reasonId":"255109","locationId":"157670"}1540306834662,
    "createdUser": "JoeSchmo",
    "professionalIddescription": 77961 "Campaign set on 10/23/2018 @ 11:00AM",
    "reasonIddisclaimerFormUUid": null,
    "requisitionNumberemail": null,
    "staffId": null,
    "status": null
}

Code Block

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

{{Email object connected to specified invitation campaign - for more info, see Emails API page},
    "businessIdemailTemplateId": 4311170689,
    "coordinatorStaffIdemploymentDurationType": null,
    "createdDateeventDefinitionList": 1540306834662,[{
        "createdUseractive": "JoeSchmo"true,
        "descriptionbusinessId": "Campaign43111,
set on 10/23/2018 @ 11:00AM",     "emailcreatedDate": {Email object connected to specified invitation campaign-see emails API page}, 1540391632663,
        "description": null,
        "emailTemplateIdeventActions": [{
 70689,     "employmentDurationType": null,     "eventDefinitionListactionType": [{"SEND_EMAIL",
            "active": true,
            "businessId": 43111,
            "createdDate": 15403916326631540391632670,
            "descriptioncreatedUser": null"JoeSchmo",
            "eventActionsemailCategoryId": [{null,
            "actionTypeemailTemplateId": "SEND_EMAIL"12937,
            "activeeventActionId": true76757,
            "businessIdeventDefnId": 4311176691,
            "createdDatemodifiedDate": 1540391632670null,
            "createdUsermodifiedUser": "JoeSchmo", null
        }],
        "emailCategoryIdeventDefnId": null76691,
            "emailTemplateIdeventType": 12937,{
            "eventActionIdeventCategory": 76757null,
            "eventDefnIdeventType": 76691null,
            "modifiedDateeventTypeId": null9,
            "modifiedUserobjectType": null
        }],
        "eventDefnIdgroupIdList": 76691null,
        "eventTypelocationIdList": {
  null,
         "eventCategorymodifiedDate": null,
        "modifiedUser": null,
        "eventTypenewStatus": null,
  "COMPLETED",
         "eventTypeIdobjectId": 9124392,
            "objectType": null"INVITATION_CAMPAIGN",
        }"objectUUId": null,
        "groupIdListoldStatus": null"*",
        "locationIdListprofessionalIdList": null,
        "modifiedDatereasonIdList": null,
        "modifiedUsertriggerHours": null,
    }],
    "newStatusexpireDate": "COMPLETED"1540944000000,
    "invitationCampaignId": 124392,
    "objectIdjobRequisitionId": 124392null,
     "jobTitle": null,
    "objectTypelocationId": "INVITATION_CAMPAIGN",81181,
    "locationName": null,
    "objectUUIdmodifiedDate": null,
        "oldStatusmodifiedUser": "*"null,
        "professionalIdListparameterMap": null,{
        "reasonIdListclientId": null"6444669",
        "triggerHourscoordStaffId": null"77961",
    }],     "expireDatejobId": 1540944000000"57804",
    "invitationCampaignId": 124392,     "jobRequisitionId": null"62883",
    "jobTitle": null,     "locationId": "81181",

   "locationName": null,     "modifiedDatereasonId": null"255109", 
   "modifiedUser": null,     "parameterMaprequisitionNumber": {"1",
        "locationId"staffId: "8118182275",
     },
    "parameters": "{\"staffId\":\"77961\",\"coordStaffId\":\"77961\",\"reasonId\": \"255109\", 
        "staffId: "82275"
     },
    "parameters": "{"staffId":"82275","reasonId":"255109","locationId":"81181\"locationId\":\"495584\",\"jobId\":\"57804\",\"clientId\":\"6444669\",\"requisitionNumber\":\"1\",\"jobRequisitionId\":\"62883\"}",
    "professionalIdprofessionalId": 77961,
	"appointmentIntentId": 779611234,
    "reasonId": 255109,
    "requisitionNumber": null,
    "staffId": 82275,
    "status": null
}

Code Block

language	js
title	POST /invitationCampaign/staff{staffIdList}
linenumbers	true
collapse	true

{
    "businessId": 43111,
    "coordinatorStaffId": 77961,
    "createdDate": 1574350992582,
    "createdUser": "MORGANKEARNEY",
    "description": "Campaign for Beach, Jonny Amante, Guided meditation sent on 11/21/2019 @ 10:40AM",
    "email": {Email object connected to specified invitation campaign - for more info, see emails API page},
    "emailTemplateId": 155556,
    "employmentDurationType": null,
    "eventDefinitionList": [],
    "expireDate": null,
    "invitationCampaignId": 259369,
    "jobRequisitionId": null,
    "jobTitle": null,
    "locationId": 81181,
    "locationName": null,
    "modifiedDate": null,
    "modifiedUser": null,
    "parameterMap": {
        "staffId": "81155", 
        "coordStaffId": "77961", 
        "reasonId": "153346", 
        "locationId": "81181"},
    "parameters": {   },
    "parameters": "staffId":"81155",
        "coordStaffId":"77961",
        "reasonId":"153346",
        "locationId":"81181"{\"staffId\":\"77961\",\"coordStaffId\":\"77961\",\"reasonId\":\"255109\",\"locationId\":\"495584\",\"jobId\":\"57804\",\"clientId\":\"6444669\",\"requisitionNumber\":\"1\",\"jobRequisitionId\":\"62883\"}",
    "professionalId": 77961,
	"appointmentIntentId": 1234,
    "reasonId": 153346,
    "requisitionNnmber": null,
    "staffId": 81155,
    "status": null
}

Code Block

language	js
title	PUT /invitationCampaign
linenumbers	true
collapse	true

{
    "businessIdbusinessId": 43111,
    "calendarId": 43111null,
    "coordinatorStaffId": null,
    "createdDate": 1539956304696,
    "createdUser": "JoeSchmo",
    "description": "Campaign set on 10/19/2018 @ 9:38AM",
    "disclaimerFormUUid": null,
    "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,
    ": 1540302776156,
    "modifiedUser": "JoeSchmo",
    "parameterMap": null,
    "parameters": "{"staffId":"81651","reasonId":"153346","locationId":"157670"}"parameters": "{\"staffId\":\"77961\",\"coordStaffId\":\"77961\",\"reasonId\":\"255109\",\"locationId\":\"495584\",\"jobId\":\"57804\",\"requisitionNumber\":\"1\",\"jobRequisitionId\":\"62883\"}",
    "professionalId": 77961,
	"appointmentIntentId": 1234,
    "professionalIdreasonId": 77961null,
    "reasonIdrequisitionNumber": null,
    "requisitionNumberstaffId": null,
    "staffIdstatus": null,
    "statuswaitlistId": null
}

invitationCampaign

Property Name	Type	Required	Description
businessId	integer	Yes	Provides unique numeric ID for the business to which the specified invitation campaign belongs.
calendarId	integer		Provides unique numeric ID for the calendar to which the specified invitation campaign belongs.
coordinatorStaffId	integer		Provides unique numeric ID for any coordinator staff connected to the specified invitation campaign.
createdDate	integer		Displays as date the specified invitation campaign was created in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
createdUser	string		Displays as username of the user who created the specified invitation campaign.
description	string		Displays as description of the specified invitation campaign.
disclaimerFormUUid	string		Provides unique alphanumeric ID for any disclaimer form connected to the specified invitation campaign.
email	object	Yes	Displays as email object connected to the specified invitation campaign - for more info, see Emails API page.
emailTemplateId	integer		Provides unique numeric ID of email template used for the specified invitation campaign.
employmentDurationType	string		Displays as a string that can be merged to the specified invitation with the tag REQ_DURATION_TYPE%.
eventDefinitionList	array		Displays as an array of eventDefinition objects. For more information, see Events API page.
expireDate	integer		Displays as date the specified invitation campaign is set to expire in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
invitationCampaignId	integer	Yes, on PUT calls	Provides unique numeric ID for the specified invitation campaign.
jobRequisitionId	integer		Provides unique numeric requisition ID for the specified job.
jobTitle	string		Displays as the job title entered on business' account.
modifiedDate	integer		Displays as date the 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 the specified invitation campaign.
parameterMap	object		Displays parameters for call being made in object form.
parameters	string		Displays as string representations of parameters for call being made.
professionalId	integer		Provides unique numeric ID for any staff connected to the specified invitation campaign.
reasonId	integer		Provides unique numeric ID for any reason connected to the specified invitation campaign.
requisitionNumber	integer		Displays as number stored on the specified job requisition. Requisition numbers are used to connect candidates to appointments booked.
staffId	integer		Provides unique numeric ID for any staff connected to the specified invitation campaign.
status	string		Displays as status of the specified invitation campaign.
waitlistId	integer		Provides unique numeric ID for any waitlist connected to the specified invitation campaign.
appointmentIntentId	integer		Provides unique numeric ID for any appointment intents connected to the specified invitation campaign.

invitation

Property Name	Type	Description
businessId	integer	Provides unique numeric ID for the business to which the specified invitation belongs.
clickDate	integer	Displays as date the specified invitation was clicked in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
clicked	boolean	Indicates whether or not the specified invitation should show as clicked.
completed	boolean	Indicates whether or not the specified invitation should show as completed.
completedDate	integer	Displays as date the specified invitation was completed in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
createdDate	integer	Displays as date the specified invitation was created in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
createdUser	string	Displays as username of user who created the specified invitation.
declineDate	integer	Displays as date the specified invitation was declined in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
declined	boolean	Indicates whether or not the specified invitation should show as declined.
email	object	Displays as email object connected to the specified invitation.
invitationCampaignId	integer	Provides unique numeric ID for invitation campaign connected to the specified invitation.
invitationUUId	string	Provides unique alphanumeric ID for the specified invitation.
modifiedDate	integer	Displays as date the 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 the specified invitation.
objectId	integer	Provides unique numeric ID for object connected to the specified invitation.
objectType	string	Displays as the objectType of the specified invitation. Has available options "CLIENT'", "STAFF", and "APPOINTMENT".
openDate	integer	Displays as date the specified invitation was opened in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
opened	boolean	Indicates whether or not the specified invitation has been opened by recipient.
sent	boolean	Indicates whether or not the specified invitation has successfully sent.
status	string	Displays as status of the specified invitation. Has available options "PENDING", "SENT", "OPENED", "CLICKED", "COMPLETED", "DECLINED"
unsubscribed	boolean	Indicates whether or not the specified invitation should show as unsubscribed.

Versions Compared

Old Version 63

New Version Current

Key

Invitations API Endpoints
Anchor
invoiceAPI
invoiceAPI

Invitations API Parameters

Invitations API

Request Body/Payloads

Invitations API Responses

Invitations Object Values

invitationCampaign

invitation

Page Comparison

Versions Compared

Old Version 63

New Version Current

Key

Invitations API Endpoints AnchorinvoiceAPIinvoiceAPI

Invitations API Parameters

Invitations API

Request Body/Payloads

Invitations API Responses

Invitations Object Values

invitationCampaign

invitation

Invitations API Endpoints
Anchor
invoiceAPI
invoiceAPI