UUpward API
v1
POST/api/public/v1/crm/create-sms
Requires x-auth-token

Log a text message

Add a text-message activity — requires an active SMS Center number.

How it works

  • Authenticate with your company API key in x-auth-token.
  • Identify the member with x-auth-user (their pagename or your own external_id).
  • Link it to a lead or contact: send lead_id or contact_id (one is required).

Requirements (otherwise 403)

  • The member has a dedicated number purchased in the SMS Center.
  • The recipient has not replied STOP.

Good to know

  • The text is recorded for the member to send.
  • This endpoint never texts anyone.

Body fields

titlestring (1–200)required

What the activity is called on the CRM calendar.

lead_iduuidoptional

The lead this activity belongs to. Send lead_id or contact_id — one is required.

contact_iduuidoptional

The contact this activity belongs to. Send lead_id or contact_id — one is required.

scheduled_atstring (ISO 8601)required

Start date and time, with an explicit UTC offset or Z.

duration_minutesnumber (1–1440)optional

Length in minutes. Defaults to 30.

prioritylow | normal | highoptional

Defaults to normal.

availabilitybusy | freeoptional

How the slot shows on the calendar. Defaults to busy.

notesstring (≤20000)optional

Free-text notes stored on the activity.

phone_numberstring (+country format)required

Destination number in full international format.

phone_countrystring (ISO 3166-1 alpha-2)optional

Country used when a national number is sent.

messagestring (1–1600)required

Text message body.

Responses

201CreatedThe text activity is on the member's CRM calendar; nothing was sent.
{ "success": true, "error": "none", "activity_id": "0b1f0a2c-8f3e-4a51-9c0d-1c2b3a4d5e6f", "kind": "sms", "sent": false }
403SMS Center inactiveThe member has no active SMS Center number, or the recipient opted out.
{ "success": false, "error": "SMS Center is not active for this member. Buy a dedicated number in the SMS Center first." }
401UnauthorizedMissing or invalid x-auth-token, or a missing x-auth-user header.
{ "success": false, "error": "Missing x-auth-token header" }
404Member not foundNo active member in your company matches x-auth-user.
{ "success": false, "error": "No member matches "jane-doe" in this company." }
422Validation failedA field is missing or invalid, or the lead / contact does not belong to this member.
{ "success": false, "error": "Validation failed", "issues": ["scheduled_at: Use an ISO 8601 date and time, e.g. 2026-04-12T15:00:00Z"] }
POST/api/public/v1/crm/create-sms

What the activity is called on the CRM calendar.

The lead this activity belongs to. Send lead_id or contact_id — one is required.

The contact this activity belongs to. Send lead_id or contact_id — one is required.

Start date and time, with an explicit UTC offset or Z.

Length in minutes. Defaults to 30.

Defaults to normal.

How the slot shows on the calendar. Defaults to busy.

Free-text notes stored on the activity.

Destination number in full international format.

Country used when a national number is sent.

Text message body.

ResponseNot sent yet