Create group member

post

https://api.mobilize.io/v1.1/groups/{group_id}/members

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
If the user id is not supplied, the user will be created automatically for convenience reasons. Make sure you include the email in the fields hash.
For adding an existing user to a group, add user_id param to the root of your JSON request.

Path Params

group_id

int32

required

The unique identifier associated to each of your groups.

Body Params

The member to place in the group. Identify an existing member with user_id, or supply
an email in fields to create one. Supplying both uses user_id. A user_id matching
no member in the organization is ignored rather than rejected, and the request falls
back to fields, so a mistyped identifier can add or create a different member.

user_id

int32

The unique identifier associated to each of your users

registration_status

string

enum

Defaults to accepted

The member's status in the group.

Allowed:

external_ids

array of objects

The member's complete set of namespaced external identifiers. Any identifier the
member already has and this array omits is removed, and an empty array removes all of
them. Omitting the property leaves the member's existing identifiers alone.

external_ids

fields

object

Profile fields for the user.
Each property must correspond to a defined or special field.
If the name field is specified alongside first_name and/or last_name, name will take precedence.

membership_tier

object

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400There was a problem with the request. Refer to the response body for details.

401Credentials were missing from the request or were not valid.

404The requested resource was not found.

422There was a problem with the request. Refer to the response body for details.

429The rate limit of 100 requests per minute per source IP address was exceeded. Enforced at the load balancer ahead of the application; the response has no body.