Agendize Developers API

Home > Agendize Scheduling

Conferences

{ "id": {string}, "title": {string}, "description": {string}, "externalId": {string}, "picture": { "url": {string}, "mimeType": {string}, "data": {string} }, "location": { "type": {string}, "text": {string}, "street": {string}, "additionalStreet": {string}, "zipCode": {string}, "state": {string}, "city": {string}, "country": {string}, "geolocation": { "lat": {float}, "lng": {float} }, "companyId": {string} }, "capacity": {integer}, "duration": {integer}, "webLink": {string}, "code": {string}, "tags": [ { "id": {string}, "text": {string} } ], "form": { "contactFields": [ {FormItem object} ], "additionalFields": [ [ {FormItem object} ] ] }, "availability": {string}, "registrationRules": { "allowAdditionalSeats": {boolean}, "numberOfAdditionalSeats": (integer} }, "cipherId": {string} }
Primary fields of the form, will always contain following bind fields : crm-last-name, crm-first-name, crm-email and crm-phone. If absent, a default value will be set. FormItem object is described here.
id string Identifier of the conference. read-only.
title string Title of the conference. Max length 127. writable.
location object Location of the conference writable.
location.type string Type of location. Values: "address", "link", "custom", "schedulingCompanyAddress". writable.
location.text string Location custom text. Only for "custom" location type. writable.
location.street string Main street address. Max length 127. Only for "address" location type. writable.
location.additionalStreet string Optional street address. Max length 127. Only for "address" location type. writable.
location.zipCode string Zip code of address. Max length 127. Only for "address" and "schedulingCompanyAddress" location types. writable for "address" location type. Read-only for "schedulingCompanyAddress" location type.
location.state string State of address. Max length 127. Only for "address" and "schedulingCompanyAddress" location types. writable for "address" location type. Read-only for "schedulingCompanyAddress" location type.
location.city string City of address. Max length 127. Only for "address" and "schedulingCompanyAddress" location types. writable for "address" location type. Read-only for "schedulingCompanyAddress" location type.
location.country string Country of address. ISO 3166-1 alpha-2 code. Only for "address" and "schedulingCompanyAddress" location types. writable for "address" location type. Read-only for "schedulingCompanyAddress" location type.
location.geolocation object Address geolocation coordinates. Only for "address" location type. writable.
location.geolocation.lat float Latitude coordinate. writable.
location.geolocation.lng float Longitude coordinate. writable.
location.companyId string Scheduling company identifier. Only for "schedulingCompanyAddress" location type. writable.
description string Description of the conference. HTML code allowed. writable.
picture object Conference picture url and mime type. writable.
picture.url string Url of the conference picture. writable.
picture.mimeType string Mime type of the conference picture file. read-only.
picture.data string URI encoding image data. write-only.
externalId string Unique conference identifier from another (external) system. Max length 255. read-only.
capacity integer Number of seats of the conference. writable.
duration integer Duration of the conference, in minutes. writable.
webLink string Web link of the conference. read-only.
code string Unique and readable identifier. writable.
tags list List of tags of conference. writable.
tags[].id list Identifier of the tag. read-only.
tags[].text list Text of the tag. writable.
form object Contact form of the conference. The same object of the WidgetForm API.
form.contactFields list
form.additionalFields list Additional fields pages of the form. Each json array in this field are equals to a page in the scheduling widget. FormItem object is described here.
availability string Availability of the conference. Values: "public", "private". writable.
registrationRules object SubscriptionRules rules of the conference. writable.
registrationRules.allowAdditionalSeats boolean Allow subscriber to subscribe more than a seat. Default value: false. writable.
registrationRules.numberOfAdditionalSeats integer Number of additional seats than a subscriber can subscribe. Default value: 0. writable.
cipherId string Ciphered identifier of the conference. read-only

Delete

Deletes an entry on the conference 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}

Parameters

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

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 user's conference 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}

Parameters

Parameter name Value Description
Path parameters
conferenceId string Conference identifier or external id.
Optional query parameters
fields string Specify the fields returned. Comma separated field names (ex: "id,title").
withSpeakers boolean Add the speaker list in the "speakers" property.
withInvitees boolean Add the invite list in the "invitees" property.
withSessions boolean Add the session list in the "sessions" property.

Request body

Do not supply a request body with this method.

Response

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

List

Returns entries on the conference 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

Parameters

Parameter name Value Description
Optional query parameters
Optional query parameters
fields string Specify the fields returned. Comma separated field names (ex: "id,title").
withSpeakers boolean Add the speaker list in the "speakers" property.
withInvitees boolean Add the invite list in the "invitees" property.
withSessions boolean Add the session list in the "sessions" property.
withForms boolean Add form fields for each conference retrieved.

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: [Conference Resource] }

Insert

Adds an entry to the conference 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

Parameters

Parameter name Value Description
Optional query parameters
fields string Specify the fields returned. Comma separated field names (ex: "id,title").
withSpeakers boolean Add the speaker list in the "speakers" property.
withInvitees boolean Add the invite list in the "invitees" property.
withSessions boolean Add the session list in the "sessions" property.

Request body

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

Parameter name Value Description
Required Properties
title string Title of the conference.
duration integer Duration of the conference, in minutes.
Optional Properties
location object Location of the conference
location.type string Type of location. Values: "address", "link", "custom".
location.text string Location custom text. Only for "custom" location type.
location.street string Main street address. Max length 127. Only for "address" location type.
location.additionalStreet string Optional street address. Max length 127. Only for "address" location type.
location.zipCode string Zip code of address. Max length 127. Only for "address" location type.
location.state string State of address. Max length 127. Only for "address" location type.
location.city string City of address. Max length 127. Only for "address" location type.
location.country string Country of address. ISO 3166-1 alpha-2 code. Only for "address" location type.
description string Description of the conference. HTML code allowed.
picture object Conference picture url and mime type.
picture.url string Url of the conference picture.
picture.mimeType string Mime type of the conference picture file.
picture.data string Data URI of the picture (eg: image/png;base64, xxxxx). See Data URI scheme. Max size: 1MB. If the size is exceeded the picture is ignored.
externalId string Unique conference identifier from another (external) system. Max length 255.
capacity integer Number of seats of the conference.
webLink string Web link of the conference.
code string Unique and readable identifier.
tags list List of tags of conference.
tags[].id list Identifier of the tag.
tags[].text list Text of the tag.
form object Contact form of the conference.
availability string Availability of the conference. Values: "public", "private".
registrationRules object SubscriptionRules rules of the conference.
registrationRules.allowAdditionalSeats boolean Allow subscriber to subscribe more than a seat. Default value: false.
registrationRules.numberOfAdditionalSeats integer Number of additional seats than a subscriber can subscribe. Default value: 0.

Response

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

Update

Updates an entry on the conference 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}

Parameters

Parameter name Value Description
Path parameters
conferenceId string Conference identifier or external id.
Optional query parameters
fields string Specify the fields returned. Comma separated field names (ex: "id,title").
withSpeakers boolean Add the speaker list in the "speakers" property.
withInvitees boolean Add the invite list in the "invitees" property.
withSessions boolean Add the session list in the "sessions" property.

Request body

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

Parameter name Value Description
Optional Properties
location object Location of the conference
location.type string Type of location. Values: "address", "link", "custom".
location.text string Location custom text. Only for "custom" location type.
location.street string Main street address. Max length 127. Only for "address" location type.
location.additionalStreet string Optional street address. Max length 127. Only for "address" location type.
location.zipCode string Zip code of address. Max length 127. Only for "address" location type.
location.state string State of address. Max length 127. Only for "address" location type.
location.city string City of address. Max length 127. Only for "address" location type.
location.country string Country of address. ISO 3166-1 alpha-2 code. Only for "address" location type.
description string Description of the conference. HTML code allowed.
picture object Conference picture url and mime type.
picture.url string Url of the conference picture.
picture.mimeType string Mime type of the conference picture file.
picture.data string Data URI of the picture (eg: image/png;base64, xxxxx). See Data URI scheme. Max size: 1MB. If the size is exceeded the picture is ignored. write-only.
externalId string Unique conference identifier from another (external) system. Max length 255.
capacity integer Number of seats of the conference.
duration integer Duration of the conference, in minutes.
webLink string Web link of the conference.
code string Unique and readable identifier.
tags list List of tags of conference.
tags[].id list Identifier of the tag.
tags[].text list Text of the tag.
form object Contact form of the conference.
availability string Availability of the conference. Values: "public", "private".
registrationRules object SubscriptionRules rules of the conference.
registrationRules.allowAdditionalSeats boolean Allow subscriber to subscribe more than a seat. Default value: false.
registrationRules.numberOfAdditionalSeats integer Number of additional seats than a subscriber can subscribe. Default value: 0.

Response

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

Watch

Watch for changes to Conference resources.

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

The watch send a Conference resource in the request body

Request

HTTP Request

POST https://api.agendize.com/conferences/api/1.0/conferences/watch

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 added in dashboard or API. In this case, the watch request add the following header property in http request:
    X-Agendize-objectEvent: created
  • Conference modified in dashboard or API. In this case, the watch request add the following header property in http request:
    X-Agendize-objectEvent: updated
  • Conference 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.