HTTP API - Quick Reference

Attribute syntax

Attribute Name

Data type

Example

sdr_o=<text>

Account ID

Any text

sdr_o=21212

sdr_ofid=<text>

OFID

Any text

sdr_ofid=12345678A90

sdr_odn=<text>

Account Name

Any text

sdr_odn=Acme

sdr_u=<text>

user-id

Any text

sdr_u=jon@acme.com

sdr_u.name=<text>

User Name

Any text

sdr_u.name=Jon

sdr_o.Create%20Date=<date>

Create Date

Date ( ISO 8601 format)

sdr_o.Create%20Date=2011-12-20T19:25:58.0Z

sdr_o.Contract%20Renewal%20Date=<date>

Contract Renewal Date

Date (ISO 8601 format)

sdr_o..Contract%20Renewal%20Date=2011-12-20T19:25:58.0Z

sdr_o.Contract%20Value=<number>

Contract Value (MRR or ARR)

Number larger than 1

sdr_o.Contract%20Value=5000

sdr_o.Licenses=<number>

Licenses

Number larger than 1

sdr_o.Licenses=12

sdr_o.Sales%20Manager=<text>

Sales Manager

Any text

sdr_o.Sales%20Manager=Jon%20Smith

sdr_o.Success%20Manager=<text>

Success Manager

Any text

sdr_o.Success%20Manager=Jon%20Smith

sdr_o.Status=<status type>

Account Status

Status type (must be a defined status)

sdr_o.Status=Paying

sdr_o.Cancellation%20Date=<date>

Cancellation Date

sdr_o.Cancellation%20Date=2016-10-12T15:26:42.3Z

sdr_o.Account%20Type=<account type>

Account Type

sdr_o.Account%20Type=Premier

sdr_o.Company%20Size=<number>

Company Size

sdr_o.Company%20Size=800

sdr_o.Contract%20Start%20Date=<date>

Contract Start Date

sdr_o.Contract%20Start%20Date=2012-05-16T12:20:25.0Z

sdr_o.Forecast%20Contract%20Value=<number>

Forecast Contract Value

sdr_o.Forecast%20Contract%20Value=25000

sdr_o.Forecast%20Period=<date>

Forecast Period

sdr_o.Forecast%20Period=2016-6-11T16:36:47.3Z

sdr_o.Forecast%20State=<text>

Forecast State

sdr_o.Forecast%20State=Renewing

sdr_o.Last%20Contract%20Value%20Change%20Date=<date>

Last Contract Value Change Date

sdr_o.Last%20Contract%20Value%20Change%20Date=2011-09-01T18:30:25.0Z

sdr_o.parent_id=<text>

parent_id

sdr_o.parent_id=12837ASf

sdr_o.product_id=<text>

product_id

sdr_o.product_id=excelsior%20version_1.5

sdr_o.Trial%20Expiration%20Date=<date>

Trial Expiration Date

sdr_o.Trial%20Expiration%20Date=2011-12-20T19:25:58.0Z

sdr_o.<attribute>=<value>

account level attribute

Any text

sdr_o.accountindustrytype=industrial

sdr_u.<attribute>=<value>

user level attribute

Any text

sdr_u.userphone=555-3232

sdr_s=<text>                                   

Service Instance ID

Any text

sdr_u.Key%20Contact=yes

Key Contact

Set to "yes" 

 (lowercase)

sdr_a=<text>

Action

Any text

sdr_a=login

sdr_m=<text>

Module

Any text

sdr_m=dashboard