🗃️Endpoints - Tags

List tags

get

List tags

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

Get a tag by a specific name

name[contains]stringOptionnel

Get a tag that contains this name

Réponses

200

Tags returned successfully

application/json

400

Malformed payload

get

/v1/tags

HTTPcURLJavaScriptPython

GET /v1/tags HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*

{
  "items": [
    {
      "id": "text",
      "name": "text",
      "emoji": "text",
      "order": 1
    }
  ],
  "total": 1
}

Create a tag

post

Create a tag

Corps

application/json

namestringRequis

Name of the tag

emojistringOptionnel

Emoji of the tag

Réponses

201

The tag has been successfully created

application/json

400

Malformed payload

post

/v1/tags

HTTPcURLJavaScriptPython

POST /v1/tags HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "name": "text",
  "emoji": "text"
}

{
  "id": "text",
  "name": "text",
  "emoji": "text",
  "order": 1
}

Get a tag

get

Get a tag

Paramètres de chemin

tagIdstringRequis

The id of the tag

Réponses

200

Tag found and returned successfully

application/json

400

Malformed payload

404

Tag not found

get

/v1/tags/{tagId}

HTTPcURLJavaScriptPython

GET /v1/tags/{tagId} HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*

{
  "id": "text",
  "name": "text",
  "emoji": "text",
  "order": 1
}

Delete a tag

delete

Delete a tag

Paramètres de chemin

tagIdstringRequis

The id of the tag

Réponses

204

Tag successfully deleted

400

Malformed payload

404

Tag not found

delete

/v1/tags/{tagId}

HTTPcURLJavaScriptPython

DELETE /v1/tags/{tagId} HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*

Aucun contenu

Update a tag

put

Update a tag

Paramètres de chemin

tagIdstringRequis

The id of the tag

Corps

application/json

namestringOptionnel

The name of the tag

emojistring | nullableOptionnel

The emoji of the tag

Réponses

200

Tag successfully updated

application/json

400

Malformed payload

404

Tag not found

put

/v1/tags/{tagId}

HTTPcURLJavaScriptPython

PUT /v1/tags/{tagId} HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "name": "text",
  "emoji": "text"
}

{
  "id": "text",
  "name": "text",
  "emoji": "text",
  "order": 1
}

Assign multiple spot members to a tag

post

Assign spot members to a tag

Paramètres de chemin

tagIdstringRequis

The id of the tag

Corps

application/json

spotMemberIdsstring[]Requis

The ids of the spotMembers to assign to the tag

Réponses

204

Spot members successfully assigned

400

Malformed payload

post

/v1/tags/{tagId}/spotMembers~bulkAssign

HTTPcURLJavaScriptPython

POST /v1/tags/{tagId}/spotMembers~bulkAssign HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "spotMemberIds": [
    "text"
  ]
}

Aucun contenu

Unassign multiple spot members to a tag

post

Unassign spot members to a tag

Paramètres de chemin

tagIdstringRequis

The id of the tag

Corps

application/json

spotMemberIdsstring[]Requis

The ids of the spotMembers to unassign to the tag

Réponses

204

Spot members successfully unassigned

400

Malformed payload

post

/v1/tags/{tagId}/spotMembers~bulkUnassign

HTTPcURLJavaScriptPython

POST /v1/tags/{tagId}/spotMembers~bulkUnassign HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "spotMemberIds": [
    "text"
  ]
}

Aucun contenu

List tagged members

get

List Tagged members

Paramètres de chemin

tagIdstringRequis

The id of the tag

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

Tagged members returned successfully

application/json

400

Malformed payload

get

/v1/tags/{tagId}/spotMembers

HTTPcURLJavaScriptPython

GET /v1/tags/{tagId}/spotMembers HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*

{
  "items": [
    {
      "id": "text",
      "spotId": "text",
      "userId": "text",
      "email": "text",
      "title": "text",
      "role": "Member",
      "customRoleId": "text",
      "status": "Accepted",
      "firstname": "text",
      "lastname": "text",
      "warnings": 1,
      "embedBaseUrls": {
        "default": "text",
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "total": 1
}

Create multiple tags

post

Create multiple tags

Corpsobject[]

application/json

namestringRequis

Name of the tag

emojistringOptionnel

Emoji of the tag

Réponses

201

Tags has been successfully created

application/json

400

Malformed payload

413

Payload is too large

post

/v1/tags~bulkCreate

HTTPcURLJavaScriptPython

POST /v1/tags~bulkCreate HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 32

[
  {
    "name": "text",
    "emoji": "text"
  }
]

{
  "created": [
    {
      "id": "text",
      "name": "text",
      "emoji": "text",
      "order": 1
    }
  ],
  "failed": [
    {
      "name": "text",
      "emoji": "text"
    }
  ]
}