Skip to the page

Praecise Platform

Rivier/ Reference/ contacts

Change a segment

patch/crm/segments/{id}

Before you call

Credential: Authorization: Bearer $KEY
Scope: contacts:write
Graphql: Mutation.contactsSegmentUpdate
Sdk: contacts.segment.update
Cli: contacts segment update

Parameters

idstring (uuid)required
In the path

Request bodyapplication/json, required

namestringrequired
At most 120 characters.
descriptionstring
At most 500 characters.
rulesobjectrequired

Responses

200application/json
Success
object
400application/json
The request was malformed
- errorstringrequired
- messagestring
401application/json
No valid credential
- errorstringrequired
- messagestring
403application/json
The credential lacks the scope, origin or address
- errorstringrequired
- messagestring
429application/json
Over the key's rate limit; see Retry-After
- errorstringrequired
- messagestring

Example request

curl -X PATCH 'https://api.rivier.ai/crm/segments/{id}' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "rules": {
    "all": []
  }
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown