πŸ—ƒοΈEndpoints - Forums

Get a forum

get

Get a forum

Paramètres de chemin
forumIdstringRequis

The id of the forum

RΓ©ponses
200

Forum found and returned successfully

application/json
get
/v1/forums/{forumId}

Update a forum

put

Update a forum

Paramètres de chemin
forumIdstringRequis

The id of the forum

Corps
namestringOptionnel

The name of the forum

descriptionstring | nullableOptionnel

The description of the forum

emojistring | nullableOptionnel

The emoji of the forum

privacystring Β· enumOptionnel

Privacy of the forum

Valeurs possibles:
RΓ©ponses
200

Forum successfully updated

application/json
put
/v1/forums/{forumId}

Delete a forum

delete

Delete a forum

Paramètres de chemin
forumIdstringRequis

The id of the forum

RΓ©ponses
delete
/v1/forums/{forumId}

Aucun contenu

List forums

get

List forums

ParamΓ¨tres de requΓͺte
pageinteger | nullableOptionnel

The page number in a paginated set of results

limitinteger | nullableOptionnel

The limit of results to be returned per page

name[eq]stringOptionnel

Search Forum with a specified name

name[contains]stringOptionnel

Search Forum that contains this value in his name

RΓ©ponses
200

Forums returned successfully

application/json
get
/v1/forums

Create a forum

post

Create a forum

Corps
namestringRequis

Name of the forum

descriptionstringOptionnel

Description of the forum

emojistringOptionnel

Emoji of the forum

privacystring Β· enumOptionnel

Privacy of the forum

Default: PrivateValeurs possibles:
RΓ©ponses
post
/v1/forums

List forums members

get

List Forum Members

Paramètres de chemin
forumIdstringRequis

The id of the forum

ParamΓ¨tres de requΓͺte
pageinteger | nullableOptionnel

The page number in a paginated set of results

limitinteger | nullableOptionnel

The limit of results to be returned per page

email[in]string[]Optionnel

The emails of spot member to include in the result

firstname[in]string[]Optionnel

The firstnames of spot member to include in the result

lastname[in]string[]Optionnel

The lastnames of spot member to include in the result

registrationDate[before]integerOptionnel

Spot members where registration date is before a specific date (Unix timestamp format)

registrationDate[after]integerOptionnel

Spot members where registration date is after a specific date (Unix timestamp format)

RΓ©ponses
200

Forum members returned successfully

application/json
get
/v1/forums/{forumId}/spotMembers

Add member to a forum

post

Add member to a forum

Paramètres de chemin
forumIdstringRequis

The id of the forum

Corps
spotMemberIdstringRequis

An uuid representing the unique identifier of the spot member to add to forum

RΓ©ponses
post
/v1/forums/{forumId}/spotMembers

Aucun contenu

Add multiple members to a forum

post

Add members to a forum

Paramètres de chemin
forumIdstringRequis

The id of the forum

Corps
spotMemberIdsstring[]Requis

An array of strings representing the unique identifiers of spot members to add to forum

RΓ©ponses
200

Members successfully added

application/json
post
/v1/forums/{forumId}/spotMembers~bulkAdd

Remove multiple members from a forum

post

Remove members from a forum

Paramètres de chemin
forumIdstringRequis

The id of the forum

Corps
spotMemberIdsstring[]Requis

An array of strings representing the unique identifiers of spot members to remove from forum

RΓ©ponses
200

Members successfully removed

application/json
post
/v1/forums/{forumId}/spotMembers~bulkRemove

Create multiple forums

post

Create multiple forums

Corpsobject[]
namestringRequis

Name of the forum

descriptionstringOptionnel

Description of the forum

emojistringOptionnel

Emoji of the forum

privacystring Β· enumOptionnel

Privacy of the forum

Default: PrivateValeurs possibles:
RΓ©ponses
post
/v1/forums~bulkCreate

Mis Γ  jour

Ce contenu vous a-t-il Γ©tΓ© utileβ€―?