Skip to content
Vocapable Developers

Rename a contact list

PATCH
/v1/contact-lists/{list_id}
curl --request PATCH \
  --url https://api.vocapable.com/v1/contact-lists/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example" }'

Rename it, and nothing else.

consent_basis and attestation_ref are not writable here. They record what a named human affirmed about these rows at import time, and every dial made against the list cites them - an attestation that can be edited afterwards is not evidence.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
list_id
required
List Id
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
ContactListUpdateRequest

PATCH on a list: the name, and nothing else.

consent_basis and attestation_ref are deliberately not writable. They record what a named human affirmed about the rows on this list at the moment it was created, and every dial made against it cites them - an attestation that can be edited afterwards is not evidence of anything (docs/03-domain-model.md §Audience).

object
name
required
Name
string
>= 1 characters <= 200 characters
Examplegenerated
{
  "name": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
ContactListSummary
object
id
required
Id
string
name
required
Name
string
source
required
Source
string
Allowed values: upload api
consent_basis
Any of:
ConsentBasis

CANON fact 18 - the four consent classes (docs/07-compliance.md §consent).

string
Allowed values: pewc pec ebr transactional
attestation_ref
Any of:
string
contact_count
required
Contact Count
integer
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
Example
{
  "source": "upload",
  "consent_basis": "pewc"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}