Agendize Developers API

Home > Agendize Scheduling

Conference Invitees

{ "id": {string}, "firstName": {string}, "lastName": {string}, "emailAddress": {string}, "phoneNumber": {string}, "status": {string} }
id string Identifier of the invitee. read-only
firstName string First name of the invitee. writable
lastName string Last name of the invitee. writable
emailAddress string Email address of the invitee. writable
phoneNumber string Phone number of the invitee. writable
status string Status of the invitee. Values: "pending", "accepted", "refused". writable

Delete

Deletes an entry on the conference invitee list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

DELETE https://api.agendize.com/conferences/api/1.0/conferences/{conferenceId}/invitees/{inviteeId}

Parameters

Parameter name Value Description
Path parameters
conferenceId string Conference identifier or external id.
inviteId string Invitee identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns an empty response body.

Get

Returns an entry of the conference invitee list

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET https://api.agendize.com/conferences/api/1.0/conferences/{conferenceId}/sessions/{inviteeId}

Parameters

Parameter name Value Description
Path parameters
conferenceId string Conference identifier or external id.
inviteeId string Invitee identifier.
Optional query parameters
fields string Specify the fields returned. Comma separated field names (ex: "id,title").

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a Invitee resource in the response body.

List

Returns entries on the conference invitee list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET https://api.agendize.com/conferences/api/1.0/conferences/{conferenceId}/invitees

Parameters

Parameter name Value Description
Optional query parameters
Optional query parameters
fields string Specify the fields returned. Comma separated field names (ex: "id,title").

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{ items: [Invitee Resource] }

Insert

Adds an entry to the conference invitee list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

POST https://api.agendize.com/conferences/api/1.0/conferences/{conferenceId}/invitees

Parameters

Parameter name Value Description
Path parameters
conferenceId string Conference identifier or external id.

Request body

In the request body, supply a Invitee resource with the following properties:

Parameter name Value Description
Required Properties
lastName string Last name of the invitee. writable
Optional Properties
firstName string First name of the invitee. writable
lastName string Last name of the invitee. writable
emailAddress string Email address of the invitee. writable
phoneNumber string Phone number of the invitee. writable
status string Status of the invitee. Values: "pending", "accepted", "refused". writable

Response

If successful, this method returns a Invitee resource in the response body.

Update

Updates an entry on the conference session list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

PUT https://api.agendize.com/conferences/api/1.0/conferences/{conferenceId}/invitees/{inviteeId}

Parameters

Parameter name Value Description
Path parameters
conferenceId string Conference identifier or external id.
inviteeId string Invitee identifier.

Request body

In the request body, supply a Invitee resource with the following properties:

Parameter name Value Description
Optional Properties
firstName string First name of the invitee. writable
lastName string Last name of the invitee. writable
emailAddress string Email address of the invitee. writable
phoneNumber string Phone number of the invitee. writable
status string Status of the invitee. Values: "pending", "accepted", "refused". writable

Response

If successful, this method returns a Invitee resource in the response body.

Watch

Watch for changes to Conference Invitee resources.

Authentication is required to execute this request. Please refer to Authentication for more.

The watch send a Conference Invitee resource in the request body

Request

HTTP Request

POST https://api.agendize.com/conferences/api/1.0/conferences/{conferenceId}/invitees/watch

Parameters

Parameter name Value Description
Path parameters
conferenceId string Conference identifier or "0" for all conferences.

Request body

{ "address": {string}, "name": {string}, "basicAuth": { "username": {string}, "password": {string} }, "httpRequestHeader": { {name}: {string} }, "schema": {object} "method": {string}, "status": {string}, "oauth2Auth": { "grantType": {string}, "clientId": {string}, "clientSecret": {string}, "refreshToken": {string}, "authUrl": {string}, "accessTokenUrl": {string}, "redirectUri": {string} }, "signature": { "enabled": {boolean}, "cryptoKeyIds": [ {string} ] } }
Required Properties
address string The address where notifications are delivered for this watch.
Optional Properties
name string Name of the watch.
basicAuth string Credentials parameters for HTTP Basic authentication on the destination watch address. Only if you use this authentication method.
basicAuth.username string Username.
basicAuth.password string Password.
httpRequestHeader string Custom header parameters to send with the http request on the destination watch address.
httpRequestHeader.name string header parameter name.
schema object Custom json schema to apply for resource properties.
method string HTTP Method to use for sending content. DELETE Method doesn't accept body content.
status string Status of the watcher. Values: "enabled", "disabled"
oauth2Auth string Credentials parameters for HTTP OAuth2 authentication on the destination watch address. Only if you use this authentication method.
oauth2Auth.grantType string OAuth2 grant type. Values: "refresh_token" (default), "client_credentials".
oauth2Auth.clientId string OAuth2 client id.
oauth2Auth.refreshToken string OAuth2 refresh token. Only for grantType "refresh_token"
oauth2Auth.authUrl string OAuth2 interactive end point to initiate the generation of the refresh token. Only for grantType "refresh_token"
oauth2Auth.accessTokenUrl string OAuth2 end point to generation an access token from the refresh token.
oauth2Auth.scope string OAuth2 api scope. Only for grantType "refresh_token"
signature object Produces a crypto signature of the watched content.
signature.enabled boolean Sets if the signature is enabled or not.
signature.cryptoKeyIds list Arrays of string of crypto keys identifier.

Response

If successful, this method returns a watch resource in the response body.

Examples of schema:

With JSON, only for string value:

{ "schema": { "my_id_key": "{id}", "dataContent": { "givenName": "{firstName}" } } }

With string to support typed values:

{ "schema": "\"my_id_key\": ${$.id}, \"dataContent\": { \"fullName\": \"${$.firstName} ${$.lastName}\"}" }

Replacement string can by defined with jsonpath expressions.

Watch event supported

  • Conference invitee added in dashboard or API. In this case, the watch request add the following header property in http request:
    X-Agendize-objectEvent: created
  • Conference invitee in dashboard or API. In this case, the watch request add the following header property in http request:
    X-Agendize-objectEvent: updated
  • Conference invitee deleted in dashboard or API. In this case, the watch request add the following header property in http request:
    X-Agendize-objectEvent: deleted

Agendize | Support | Status

Last update: Oct 15, 2024 - Copyright © 2024 Agendize. All rights reserved.