Members
A Member represents a Snapchat account user who is a member of an Organization, a Member needs to be assigned a Role within both the Organization and individual Ad Accounts in order to access entities.
Attributes
Attribute | Description | Required | Possible Values |
---|---|---|---|
display_name | Name of the user | R | |
organization_id | Organization ID | R | |
member_status | Name of the Advertiser | R | INVITED, MEMBER |
email address of the user | R |
Get all Members of an Organization
curl "https://adsapi.snapchat.com/v1/organizations/8fdeefec-f502-4ca8-9a84-6411e0a51053/members" \
-H "Authorization: Bearer meowmeowmeow"
The above command returns JSON structured like this:
{
"request_status": "SUCCESS",
"request_id": "5ea05c4800ff08ac5ff42a0f740001737e616473617069736300016275696c642d64313063316333662d312d3334352d3000010102",
"members": [
{
"sub_request_status": "SUCCESS",
"member": {
"id": "a71cfcae-895d-4314-9460-e2ffd2515dd0",
"updated_at": "2017-10-17T12:25:50.815Z",
"created_at": "2017-10-17T12:25:50.815Z",
"email": "honeybear@example.com",
"organization_id": "8fdeefec-f502-4ca8-9a84-6411e0a51053",
"display_name": "Honey Bear",
"member_status": "MEMBER"
}
},
{
"sub_request_status": "SUCCESS",
"member": {
"id": "b124e762-9720-4f89-bdd2-7fe06e71d7cc",
"updated_at": "2020-03-05T11:29:31.562Z",
"created_at": "2018-09-28T19:05:09.787Z",
"email": "jack_the_bear@example.com",
"organization_id": "8fdeefec-f502-4ca8-9a84-6411e0a51053",
"display_name": "Jack Polarbear",
"member_status": "MEMBER"
}
},
{
"sub_request_status": "SUCCESS",
"member": {
"id": "d051973d-32b2-496b-b44a-345986bce17d",
"updated_at": "2020-04-22T14:56:33.164Z",
"created_at": "2020-04-22T14:45:04.452Z",
"email": "guinea_pig@example.com",
"organization_id": "8fdeefec-f502-4ca8-9a84-6411e0a51053",
"display_name": "Esmeralda the Guinea Pig",
"member_status": "MEMBER"
}
}
]
}
The following API request returns the information of all Members of an Organization, this includes their display name, email address and member status. Members who have not yet accepted their invite will have the status INVITED, members that have accepted the invite will have the status MEMBER.
HTTP Request
GET https://adsapi.snapchat.com/v1/organizations/{organization_id}/members
Parameters
Parameter | Default | Description |
---|---|---|
organization_id | Organization ID |
Get a specific Member
curl "https://adsapi.snapchat.com/v1/members/d051973d-32b2-496b-b44a-345986bce17d" \
-H "Authorization: Bearer meowmeowmeow"
The above command returns JSON structured like this:
{
"request_status": "SUCCESS",
"request_id": "5ea05dcf00ff05a0584dcd2c0f0001737e616473617069736300016275696c642d64313063316333662d312d3334352d300001015b",
"members": [
{
"sub_request_status": "SUCCESS",
"member": {
"id": "d051973d-32b2-496b-b44a-345986bce17d",
"updated_at": "2020-04-22T14:56:33.164Z",
"created_at": "2020-02-22T14:45:04.452Z",
"email": "honeybear@example.com",
"organization_id": "8fdeefec-f502-4ca8-9a84-6411e0a51053",
"display_name": "Honey Bear",
"member_status": "MEMBER"
}
}
]
}
The following API request returns the information of a specific Member.
HTTP Request
GET https://adsapi.snapchat.com/v1/members/{member_id}
Parameters
Parameter | Default | Description |
---|---|---|
member_id | Member ID |
Create Member
curl -X POST \
-d '{"members": [{"email": "honeybear@example.com","organization_id": "8fdeefec-f502-4ca8-9a84-6411e0a51053","display_name": "Honey Bear"}]}' \
-H "Content-Type: application/json" \
-H "Authorization: Bearer meowmeowmeow" \
https://adsapi.snapchat.com/v1/organizations/8fdeefec-f502-4ca8-9a84-6411e0a51053/members
The above command returns JSON structured like this:
{
"request_status": "SUCCESS",
"request_id": "5ea0587000ff0360f26d1e8c1d0001737e616473617069736300016275696c642d64313063316333662d312d3334352d3000010157",
"members": [
{
"sub_request_status": "SUCCESS",
"member": {
"id": "d051973d-32b2-496b-b44a-345986bce17d",
"updated_at": "2020-04-22T14:45:04.452Z",
"created_at": "2020-04-22T14:45:04.452Z",
"email": "honeybear@example.com",
"organization_id": "8fdeefec-f502-4ca8-9a84-6411e0a51053",
"display_name": "Honey Bear",
"member_status": "INVITED"
}
}
]
}
The following API request creates a member within the chosen Organization, this will trigger an email invite to the user in question. When
the user accepts the invite the member_status
attribute will update from INVITED to MEMBER. Member creation should always be coupled with
a Role creation within the Organization.
HTTP Request
POST https://adsapi.snapchat.com/v1/organizations/{organization_id}/members
Parameters
Parameter | Default | Description |
---|---|---|
organization_id | Organization ID |
Delete Member
curl -X DELETE "https://adsapi.snapchat.com/v1/members/d051973d-32b2-496b-b44a-345986bce17d" \
-H "Authorization: Bearer meowmeowmeow"
The above command returns JSON structured like this:
{
"request_status": "SUCCESS",
"request_id": "5ea6f3f900ff01fa13ebea326c0001737e616473617069736300016275696c642d39326335343566322d312d3334362d3000010107",
"members": []
}
The following API request deletes a member from the Organization.
HTTP Request
DELETE https://adsapi.snapchat.com/v1/{{member_id}}
Parameters
Parameter | Default | Description |
---|---|---|
member_id | Member ID |