Skip to content

Commit 11238b6

Browse files
Merge pull request #7935 from segmentio/DOC-1183
Update group spec page
2 parents 53d8bb4 + 0ff1bac commit 11238b6

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

src/connections/spec/group.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,14 @@ The Group call enables you to identify what account or organization your users a
88

99
{% include components/reference-button.html href="https://university.segment.com/introduction-to-segment/324252?reg=1&referrer=docs" icon="media/academy.svg" title="Segment University: The Segment Methods" description="Check out our high-level overview of these APIs in Segment University. (Must be logged in to access.)" %}
1010

11-
In addition to the `groupId`, which is how you'd identify the specific group or company, the group method receives traits that are specific to the group, like industry or number of employees for example, that belong to that specific account. Like the traits of an identify call, you can update these when you call the same trait with a different value.
11+
In addition to the `groupId`, which is how you'd identify the specific group or company, the group method receives traits that are specific to the group, for example the industry or number of employees, that belong to that specific account. Like the traits of an Identify call, you can update these when you call the same trait with a different value.
1212

1313
When using the Group call, it's helpful if you have accounts with multiple users.
1414

15-
16-
> info "Segment doesn't have an ungroup call"
17-
> If you're using a device-mode destination that has a method for ungrouping users, you can invoke it directly on the client side [using Segment's ready() method](/docs/connections/sources/catalog/libraries/website/javascript/#ready).
15+
> info "Segment doesn't have a native solution for removing users from a group"
16+
> If you're using a device-mode destination that has a method for removing users from a group, you can invoke it directly on the client side [using Segment's ready() method](/docs/connections/sources/catalog/libraries/website/javascript/#ready).
1817
>
19-
> For cloud-mode destinations, you can [create a Destination Function](/docs/connections/functions/destination-functions/) to ungroup users.
18+
> For cloud-mode destinations, you can [create a Destination Function](/docs/connections/functions/destination-functions/) to remove users from a group.
2019
2120

2221
Here's the payload of a typical Group call, with most [common fields](/docs/connections/spec/common/) removed:
@@ -106,7 +105,7 @@ Use the following interactive code pen to see what your Group calls would look l
106105

107106
## Group ID
108107

109-
A Group ID is the unique identifier which you recognize a group by in your own database. For example, if you're using MongoDB it might look something like `507f191e810c19729de860ea`.
108+
A Group ID is the unique identifier which you recognize a group by in your own database. For example, if you're using MongoDB, your Group ID might look something like `507f191e810c19729de860ea`.
110109

111110

112111
## Traits
@@ -132,10 +131,9 @@ The following are the reserved traits Segment has standardized:
132131
| `website` | String | Website of a group. |
133132
| `plan` | String | Plan that a group is in. |
134133

135-
**Note:** You might be used to some destinations recognizing special properties differently. For example, Mixpanel has a special `track_charges` method for accepting revenue. Luckily, you don't have to worry about those inconsistencies. Just pass along `revenue`. **Segment handles all of the destination-specific conversions for you automatically.** Same goes for the rest of the reserved properties.
134+
**Note:** You might be used to some destinations recognizing special properties differently. For example, Mixpanel has a special `track_charges` method for accepting revenue. **Segment handles all of the destination-specific conversions for you automatically.**
136135

137-
If you pass these values, `on null` will throw a `NullPointerException`.
136+
If you pass a reserved trait, `on null` will throw a `NullPointerException`.
138137
You may continue to set values inside the trait. If you do so, this would work the same as the rules do with NoSQL data. If you had set a value previously for a user and on the next request you sent the same value of that property as `on null`, it will be replaced by `null`, but if you do not send that property, the original value is persisted.
139138

140-
**Traits are case-insensitive**, so in JavaScript you can match the rest of your camel-case code by sending `createdAt`, and in Ruby you can match your snake-case code by sending `created_at`. That way the API never seems alien to your code base.
141-
139+
**Traits are case-insensitive**. In JavaScript you can match the rest of your camel-case code by sending `createdAt`, and in Ruby you can match your snake-case code by sending `created_at`. That way, the API never seems alien to your code base.

0 commit comments

Comments
 (0)