Remove event attendee

POST

/api/events/remove-attendee

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://api.eventpoint.io/api/events/remove-attendee"),
    Headers =
    {
        { "x-api-key", "<x-api-key>" },
    },
    Content = new StringContent("{ \"enroll\": true, \"eventId\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"userId\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"personId\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"attendeeId\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"externalId\": \"example\", \"name\": \"example\", \"email\": \"example\", \"phone\": \"example\", \"extraInfo\": \"example\", \"metaData\": \"example\" }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://api.eventpoint.io/api/events/remove-attendee';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: '{"enroll":true,"eventId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","userId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","personId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","attendeeId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","externalId":"example","name":"example","email":"example","phone":"example","extraInfo":"example","metaData":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.eventpoint.io/api/events/remove-attendee \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "enroll": true, "eventId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "personId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "attendeeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "externalId": "example", "name": "example", "email": "example", "phone": "example", "extraInfo": "example", "metaData": "example" }'

Authorizations

ApiKeyAuth
BearerAuth

Request Body^required

The request details.

Enroll / remove an attendee from an event

object

enroll

If enroll = true, then person is added. If false, removed.

boolean

eventId

Event id

string format: uuid

userId

Userid if known

null | string format: uuid

personId

Personid if known

null | string format: uuid

attendeeId

Attendeeid if known

null | string format: uuid

externalId

Id for external system. this is useful to build an enrollment system and tracking an attendee accross events.

null | string

name

Attendee name

null | string

email

Attendee email

null | string

phone

Attendee phone

null | string

extraInfo

Optional info to save

null | string

metaData

Optional meta data

null | object

Example^generated

{
  "enroll": true,
  "eventId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "personId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "attendeeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "externalId": "example",
  "name": "example",
  "email": "example",
  "phone": "example",
  "extraInfo": "example",
  "metaData": "example"
}

Enroll / remove an attendee from an event

object

enroll

If enroll = true, then person is added. If false, removed.

boolean

eventId

Event id

string format: uuid

userId

Userid if known

null | string format: uuid

personId

Personid if known

null | string format: uuid

attendeeId

Attendeeid if known

null | string format: uuid

externalId

Id for external system. this is useful to build an enrollment system and tracking an attendee accross events.

null | string

name

Attendee name

null | string

email

Attendee email

null | string

phone

Attendee phone

null | string

extraInfo

Optional info to save

null | string

metaData

Optional meta data

null | object

Example^generated

{
  "enroll": true,
  "eventId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "personId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "attendeeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "externalId": "example",
  "name": "example",
  "email": "example",
  "phone": "example",
  "extraInfo": "example",
  "metaData": "example"
}

Enroll / remove an attendee from an event

object

enroll

If enroll = true, then person is added. If false, removed.

boolean

eventId

Event id

string format: uuid

userId

Userid if known

null | string format: uuid

personId

Personid if known

null | string format: uuid

attendeeId

Attendeeid if known

null | string format: uuid

externalId

Id for external system. this is useful to build an enrollment system and tracking an attendee accross events.

null | string

name

Attendee name

null | string

email

Attendee email

null | string

phone

Attendee phone

null | string

extraInfo

Optional info to save

null | string

metaData

Optional meta data

null | object

Example^generated

{
  "enroll": true,
  "eventId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "personId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "attendeeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "externalId": "example",
  "name": "example",
  "email": "example",
  "phone": "example",
  "extraInfo": "example",
  "metaData": "example"
}

Responses

200

object

requestId

null | string

requestComplete

boolean

requestCompleteDate

null | string format: date-time

errors

Array<string> | null

data

object

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

eventId

string format: uuid

userId

null | string format: uuid

personId

null | string format: uuid

firstName

null | string

lastName

null | string

name

null | string

email

null | string

contactEmail

null | string

phone

null | string

jobTitle

null | string

company

null | string

ticketId

null | string format: uuid

registrantId

null | string format: uuid

invitationId

null | string format: uuid

attendanceTypeId

null | string format: uuid

networkingOptIn

null | boolean

isVirtual

boolean

hasAttended

boolean

attendedDateTime

null | string format: date-time

attendanceStatus

Allowed values: NeedsAction Declined Tentative Accepted

preferenceStatus

Allowed values: None Primary Alternate

preferenceOrder

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

enrollmentStatus

Allowed values: Pending Confirmed Waitlisted Cancelled

enrollmentDate

null | string format: date-time

enrolledByUserId

null | string format: uuid

enrollmentMode

string

waitlistOrder

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

waitlistDate

null | string format: date-time

removedFromWaitlistDate

null | string format: date-time

prefNotifyUpdates

boolean

externalId

null | string

extraInfo

null | string

meta

null | object

attendanceType

object

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

organizationId

null | string format: uuid

name

null | string

description

null | string

publish

boolean

useForAllEventTypes

boolean

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

imageUrl

null | string

imageAssetId

null | string format: uuid

itemOrder

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

hasMetaFields

boolean

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

message

null | string

success

boolean

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

object

requestId

null | string

requestComplete

boolean

requestCompleteDate

null | string format: date-time

errors

Array<string> | null

data

object

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

eventId

string format: uuid

userId

null | string format: uuid

personId

null | string format: uuid

firstName

null | string

lastName

null | string

name

null | string

email

null | string

contactEmail

null | string

phone

null | string

jobTitle

null | string

company

null | string

ticketId

null | string format: uuid

registrantId

null | string format: uuid

invitationId

null | string format: uuid

attendanceTypeId

null | string format: uuid

networkingOptIn

null | boolean

isVirtual

boolean

hasAttended

boolean

attendedDateTime

null | string format: date-time

attendanceStatus

Allowed values: NeedsAction Declined Tentative Accepted

preferenceStatus

Allowed values: None Primary Alternate

preferenceOrder

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

enrollmentStatus

Allowed values: Pending Confirmed Waitlisted Cancelled

enrollmentDate

null | string format: date-time

enrolledByUserId

null | string format: uuid

enrollmentMode

string

waitlistOrder

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

waitlistDate

null | string format: date-time

removedFromWaitlistDate

null | string format: date-time

prefNotifyUpdates

boolean

externalId

null | string

extraInfo

null | string

meta

null | object

attendanceType

object

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

organizationId

null | string format: uuid

name

null | string

description

null | string

publish

boolean

useForAllEventTypes

boolean

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

imageUrl

null | string

imageAssetId

null | string format: uuid

itemOrder

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

hasMetaFields

boolean

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

message

null | string

success

boolean

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

Example

{
  "data": {
    "attendanceStatus": "NeedsAction",
    "preferenceStatus": "None",
    "enrollmentStatus": "Pending"
  }
}

object

requestId

null | string

requestComplete

boolean

requestCompleteDate

null | string format: date-time

errors

Array<string> | null

data

object

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

eventId

string format: uuid

userId

null | string format: uuid

personId

null | string format: uuid

firstName

null | string

lastName

null | string

name

null | string

email

null | string

contactEmail

null | string

phone

null | string

jobTitle

null | string

company

null | string

ticketId

null | string format: uuid

registrantId

null | string format: uuid

invitationId

null | string format: uuid

attendanceTypeId

null | string format: uuid

networkingOptIn

null | boolean

isVirtual

boolean

hasAttended

boolean

attendedDateTime

null | string format: date-time

attendanceStatus

Allowed values: NeedsAction Declined Tentative Accepted

preferenceStatus

Allowed values: None Primary Alternate

preferenceOrder

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

enrollmentStatus

Allowed values: Pending Confirmed Waitlisted Cancelled

enrollmentDate

null | string format: date-time

enrolledByUserId

null | string format: uuid

enrollmentMode

string

waitlistOrder

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

waitlistDate

null | string format: date-time

removedFromWaitlistDate

null | string format: date-time

prefNotifyUpdates

boolean

externalId

null | string

extraInfo

null | string

meta

null | object

attendanceType

object

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

organizationId

null | string format: uuid

name

null | string

description

null | string

publish

boolean

useForAllEventTypes

boolean

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

imageUrl

null | string

imageAssetId

null | string format: uuid

itemOrder

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

hasMetaFields

boolean

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

message

null | string

success

boolean

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

Example

{
  "data": {
    "attendanceStatus": "NeedsAction",
    "preferenceStatus": "None",
    "enrollmentStatus": "Pending"
  }
}

403

Forbidden

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

Remove event attendee

Authorizations

Request Bodyrequired

Examplegenerated

Examplegenerated

Examplegenerated

Responses

200

Example

Example

403

Examplegenerated

Examplegenerated

Request Body^required

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated