SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse CRM Public Contact attributes Value API

5 actions 5 updates phrasing extends openapi/sendpulse-contact-attributes-value-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for SendPulse's API. It is a proposal applied on top of the contract, not a document SendPulse publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/contacts/{contactId}/attributes'].get
$.paths['/contacts/{contactId}/attributes'].post
$.paths['/contacts/{contactId}/attributes/{attributeId}'].put
$.paths['/contacts/{contactId}/attributes/{attributeId}'].delete

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for SendPulse CRM Public Contact attributes Value API
  version: 1.0.0
extends: openapi/sendpulse-contact-attributes-value-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/contacts/{contactId}/attributes'].get
  update:
    x-apievangelist-phrasing:
      intent: List a contact's attribute values
      effect: read
      questions:
      - What custom attribute values are set on a contact?
      - Can I see every attribute and its value for one CRM contact?
      instructions:
      - text: List attribute values for contact {contactId}.
        slots:
          contactId: path.contactId
      - text: Show custom fields filled in on contact {contactId}.
        slots:
          contactId: path.contactId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contacts/{contactId}/attributes'].post
  update:
    x-apievangelist-phrasing:
      intent: Set an attribute value on a contact
      effect: write
      questions:
      - How do I add a custom attribute value to a contact?
      - Can I fill in a field like birthday for a contact?
      instructions:
      - text: Set attribute {attributeId} to {value} on contact {contactId}.
        slots:
          attributeId: requestBody.attributeId
          value: requestBody.value
          contactId: path.contactId
      - text: Add value {value} for attribute {attributeId} to contact {contactId}.
        slots:
          value: requestBody.value
          attributeId: requestBody.attributeId
          contactId: path.contactId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contacts/{contactId}/attributes/{attributeId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a contact's existing attribute value
      effect: write
      questions:
      - Can I change an attribute value a contact already has?
      - Is it possible to overwrite one custom field on a contact?
      instructions:
      - text: Update attribute {attributeId} on contact {contactId} to {value}.
        slots:
          attributeId: path.attributeId
          contactId: path.contactId
          value: requestBody.value
      - text: Overwrite contact {contactId}'s existing {attributeId} value with {value}.
        slots:
          contactId: path.contactId
          attributeId: path.attributeId
          value: requestBody.value
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contacts/{contactId}/attributes/{attributeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear an attribute value from a contact
      effect: destructive
      questions:
      - Can I remove a custom attribute value from a contact?
      - What's the way to clear one field on a CRM contact?
      instructions:
      - text: Delete attribute {attributeId} from contact {contactId}.
        slots:
          attributeId: path.attributeId
          contactId: path.contactId
      - text: Clear contact {contactId}'s value for attribute {attributeId}.
        slots:
          contactId: path.contactId
          attributeId: path.attributeId
      method: generated
      generated: '2026-10-01'