Create a Member

In this building block you will see how to create a Member. A Member can be thought of as a User who has been invited to, joined, or left a Conversation.

Example

Ensure the following variables are set to your required values using any convenient method:

Key Description
CONVERSATION_ID The unique ID of the Conversation.
USER_ID The unique ID of the User.

Prerequisites

Use your existing application

You will need to use an existing Application that contains a Conversation in order to be able to create a Member. See the Create Conversation building block for information on how to create an Application and some sample Conversations.

Write the code

Add the following to create-member.sh:

Copy to Clipboard
curl -X "POST" "https://api.nexmo.com/beta/conversations/$CONVERSATION_ID/members" \
     -H 'Authorization: Bearer '$JWT\
     -H 'Content-Type: application/json' \
     -d $'{
  "user_id": "'$USER_ID'",
  "action": "invite",
  "channel": {
    "type": "app"
  }
}'

View full source

Run your code

Save this file to your machine and run it:

$ bash create-member.sh

Try it out

When you run the code you will create a new Member. The specified User will be invited to join the specified Conversation.