Jump to

• Request
• Response
• Examples

Create a member

post

/swm/rs/v1/members

Create a space member by adding the API user to the space associated with the given invitationToken created by the Invitation API.

The API user cannot already be a member of the space and must belong to the same merchant as the space.

Maximum membership is 20 users. Error response will occur if invitationToken has expired, or as reached its maximum acceptance count.

Triggers an email notification if the space has other members who have opted-in to receive the notification.

The parameter emailConfigMissing will appear in the response if the system is not properly configured to send out email notifications

Request

Supported Media Types

• application/json

Body ()

{
"invitationToken":"string" - Invitation token created by the Invitation API
}

Root Schema : schema

Type: string

Back to Top

Response

Supported Media Types

• application/json; charset=UTF-8

200 Response

successful operation

Body ()

Root Schema : JSONObject

Type: object

201 Response

member resource created

404 Response

space resource not found

409 Response

member resource already exits

Back to Top

Examples

Sample Request:

       {
        "invitationToken":"ZWEuUyye9IzMKVzkMIx3sHhr"
       }    

Sample Response:

       {"response":{"code":"200.4","developerMessage":"added member to space resource"},
        "userId":"thfWves5gR0ETotb",
        "spaceId":"rpCcZTzUdDbVAmRjCy2BFCOO"
    

Possible Error Codes:

       {
          "code":"404.0","developerMessage":"space resource not found",
          "code":"409.0","developerMessage":"member resource already exists",
          "code":"200.6","developerMessage":"invitation resource not valid",
          "code":"403.4","developerMessage":"max space members reached"
       }    

Back to Top